Cisco-IOS-XR-ethernet-cfm-cfg API API Reference

API generated from Cisco-IOS-XR-ethernet-cfm-cfg@2017-10-06.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

GLOBAL-INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Update operation of resource: global-interface-configuration

a1_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json
Request Example
{
  "link-status": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Create operation of resource: global-interface-configuration

a1_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json
Request Example
{
  "link-status": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Delete operation of resource: global-interface-configuration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Retrieve operation of resource: global-interface-configuration

200 OK
a1_global-interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "link-status": "string"
}

INTERFACE-CONFIGURATIONS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Update operation of resource: interface-configurations

a1_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "filtering": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "domain": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "host-routing": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "propagate-remote-status": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string"
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Create operation of resource: interface-configurations

a1_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "filtering": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "domain": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "host-routing": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "propagate-remote-status": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string"
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Delete operation of resource: interface-configurations

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Retrieve operation of resource: interface-configurations

200 OK
a1_interface-configurations_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "filtering": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "domain": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "host-routing": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "propagate-remote-status": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string"
        }
      }
    }
  ]
}

INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Update operation of resource: interface-configuration

a1_interface-configuration_schema

interface-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "filtering": "string",
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "domain": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "host-routing": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "propagate-remote-status": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    : {} 
PUT      POST     DELETE    GET    
    
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Create operation of resource: interface-configuration

a1_interface-configuration_schema

interface-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "filtering": "string",
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "domain": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "host-routing": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "propagate-remote-status": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    : {} 
PUT      POST     DELETE    GET    
    
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Delete operation of resource: interface-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Retrieve operation of resource: interface-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a1_interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "filtering": "string",
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "domain": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "host-routing": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "propagate-remote-status": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    : {} 
PUT      POST     DELETE    GET    
    
  }
}

DAMPENING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Update operation of resource: dampening

a1_dampening_schema

dampeningbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Create operation of resource: dampening

a1_dampening_schema

dampeningbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Delete operation of resource: dampening

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Retrieve operation of resource: dampening

active interface-name: string
in path

ID of active interface-name

200 OK
a1_dampening_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

MTUS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Update operation of resource: mtus

a1_mtus_schema

mtusbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Create operation of resource: mtus

a1_mtus_schema

mtusbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Delete operation of resource: mtus

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Retrieve operation of resource: mtus

active interface-name: string
in path

ID of active interface-name

200 OK
a1_mtus_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

MTU - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Update operation of resource: mtu

a1_mtu_schema

mtubody object

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

Request Content-Types: application/json
Request Example
{
  "owner": "string",
  "mtu": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Create operation of resource: mtu

a1_mtu_schema

mtubody object

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

Request Content-Types: application/json
Request Example
{
  "owner": "string",
  "mtu": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Delete operation of resource: mtu

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Retrieve operation of resource: mtu

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

200 OK
a1_mtu_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "owner": "string",
  "mtu": "integer"
}

ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Update operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Create operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Delete operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Retrieve operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a1_encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

PSEUDOWIRE-ETHER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Update operation of resource: pseudowire-ether

a1_pseudowire-ether_schema

pseudowire-etherbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Create operation of resource: pseudowire-ether

a1_pseudowire-ether_schema

pseudowire-etherbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Delete operation of resource: pseudowire-ether

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Retrieve operation of resource: pseudowire-ether

active interface-name: string
in path

ID of active interface-name

200 OK
a1_pseudowire-ether_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}

PSEUDOWIRE-IW - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Update operation of resource: pseudowire-iw

a1_pseudowire-iw_schema

pseudowire-iwbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Create operation of resource: pseudowire-iw

a1_pseudowire-iw_schema

pseudowire-iwbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Delete operation of resource: pseudowire-iw

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Retrieve operation of resource: pseudowire-iw

active interface-name: string
in path

ID of active interface-name

200 OK
a1_pseudowire-iw_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}

BVI - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Update operation of resource: bvi

a1_bvi_schema

bvibody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "host-routing": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Create operation of resource: bvi

a1_bvi_schema

bvibody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "host-routing": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Delete operation of resource: bvi

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Retrieve operation of resource: bvi

active interface-name: string
in path

ID of active interface-name

200 OK
a1_bvi_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "host-routing": [ null ]
}

L2-TRANSPORT - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Update operation of resource: l2-transport

a1_l2-transport_schema

l2-transportbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "propagate-remote-status": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Create operation of resource: l2-transport

a1_l2-transport_schema

l2-transportbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "propagate-remote-status": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Delete operation of resource: l2-transport

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Retrieve operation of resource: l2-transport

active interface-name: string
in path

ID of active interface-name

200 OK
a1_l2-transport_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "propagate-remote-status": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}

L2-PROTOCOLS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Update operation of resource: l2-protocols

a1_l2-protocols_schema

l2-protocolsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Create operation of resource: l2-protocols

a1_l2-protocols_schema

l2-protocolsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Delete operation of resource: l2-protocols

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Retrieve operation of resource: l2-protocols

active interface-name: string
in path

ID of active interface-name

200 OK
a1_l2-protocols_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}

L2-PROTOCOL - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Update operation of resource: l2-protocol

a1_l2-protocol_schema

l2-protocolbody object

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

Request Content-Types: application/json
Request Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Create operation of resource: l2-protocol

a1_l2-protocol_schema

l2-protocolbody object

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

Request Content-Types: application/json
Request Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Delete operation of resource: l2-protocol

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Retrieve operation of resource: l2-protocol

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

200 OK
a1_l2-protocol_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}

L2-ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Update operation of resource: l2-ethernet-features

a1_l2-ethernet-features_schema

l2-ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Create operation of resource: l2-ethernet-features

a1_l2-ethernet-features_schema

l2-ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Delete operation of resource: l2-ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Retrieve operation of resource: l2-ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK
a1_l2-ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}

VLAN-SUB-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Update operation of resource: vlan-sub-configuration

a1_vlan-sub-configuration_schema

vlan-sub-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Create operation of resource: vlan-sub-configuration

a1_vlan-sub-configuration_schema

vlan-sub-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Delete operation of resource: vlan-sub-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Retrieve operation of resource: vlan-sub-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a1_vlan-sub-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}

VLAN-IDENTIFIER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Update operation of resource: vlan-identifier

a1_vlan-identifier_schema

vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Create operation of resource: vlan-identifier

a1_vlan-identifier_schema

vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Delete operation of resource: vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Retrieve operation of resource: vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK
a1_vlan-identifier_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}

ETHERNET-SERVICE - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Update operation of resource: ethernet-service

a1_ethernet-service_schema

ethernet-servicebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Create operation of resource: ethernet-service

a1_ethernet-service_schema

ethernet-servicebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Delete operation of resource: ethernet-service

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Retrieve operation of resource: ethernet-service

active interface-name: string
in path

ID of active interface-name

200 OK
a1_ethernet-service_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Update operation of resource: local-traffic-default-encapsulation

a1_local-traffic-default-encapsulation_schema

local-traffic-default-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Create operation of resource: local-traffic-default-encapsulation

a1_local-traffic-default-encapsulation_schema

local-traffic-default-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Delete operation of resource: local-traffic-default-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Retrieve operation of resource: local-traffic-default-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a1_local-traffic-default-encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}

ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Update operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Create operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Delete operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Retrieve operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a1_encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

REWRITE - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Update operation of resource: rewrite

a1_rewrite_schema

rewritebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Create operation of resource: rewrite

a1_rewrite_schema

rewritebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Delete operation of resource: rewrite

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Retrieve operation of resource: rewrite

active interface-name: string
in path

ID of active interface-name

200 OK
a1_rewrite_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}

ETHERNET-BNG - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Update operation of resource: ethernet-bng

a1_ethernet-bng_schema

ethernet-bngbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Create operation of resource: ethernet-bng

a1_ethernet-bng_schema

ethernet-bngbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Delete operation of resource: ethernet-bng

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Retrieve operation of resource: ethernet-bng

active interface-name: string
in path

ID of active interface-name

200 OK
a1_ethernet-bng_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

AMBIGUOUS-ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Update operation of resource: ambiguous-encapsulation

a1_ambiguous-encapsulation_schema

ambiguous-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Create operation of resource: ambiguous-encapsulation

a1_ambiguous-encapsulation_schema

ambiguous-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Delete operation of resource: ambiguous-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Retrieve operation of resource: ambiguous-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a1_ambiguous-encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

MAC-ACCOUNTING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Update operation of resource: mac-accounting

a1_mac-accounting_schema

mac-accountingbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress": [ null ],
  "egress": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Create operation of resource: mac-accounting

a1_mac-accounting_schema

mac-accountingbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "ingress": [ null ],
  "egress": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Delete operation of resource: mac-accounting

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Retrieve operation of resource: mac-accounting

active interface-name: string
in path

ID of active interface-name

200 OK
a1_mac-accounting_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ingress": [ null ],
  "egress": [ null ]
}

ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Update operation of resource: ethernet-features

a1_ethernet-features_schema

ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "filtering": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cfg-type": "string",
              "cos7": "string",
              "cos6": "string",
              "cos5": "string",
              "cos4": "string",
              "cos3": "string",
              "cos2": "string",
              "cos1": "string",
              "cos0": "string"
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mep-id": "string"
                }
              ],
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mac-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "mep-id": "string",
              "service": "string"
            },
            "cos": "string"
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "cos": "string",
        "ais-interval": "string"
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Create operation of resource: ethernet-features

a1_ethernet-features_schema

ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "filtering": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cfg-type": "string",
              "cos7": "string",
              "cos6": "string",
              "cos5": "string",
              "cos4": "string",
              "cos3": "string",
              "cos2": "string",
              "cos1": "string",
              "cos0": "string"
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mep-id": "string"
                }
              ],
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mac-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "mep-id": "string",
              "service": "string"
            },
            "cos": "string"
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "cos": "string",
        "ais-interval": "string"
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Delete operation of resource: ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Retrieve operation of resource: ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK
a1_ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "filtering": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "cfg-type": "string",
              "cos7": "string",
              "cos6": "string",
              "cos5": "string",
              "cos4": "string",
              "cos3": "string",
              "cos2": "string",
              "cos1": "string",
              "cos0": "string"
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mep-id": "string"
                }
              ],
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "profile": "string",
                  "target-mac-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "mep-id": "string",
              "service": "string"
            },
            "cos": "string"
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "cos": "string",
        "ais-interval": "string"
      }
    }
  }
}

CFM - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/

Update operation of resource: cfm

a1_cfm_schema

cfmbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cfg-type": "string",
            "cos7": "string",
            "cos6": "string",
            "cos5": "string",
            "cos4": "string",
            "cos3": "string",
            "cos2": "string",
            "cos1": "string",
            "cos0": "string"
          },
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mep-id": "string"
              }
            ],
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mac-address": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "mep-id": "string",
            "service": "string"
          },
          "cos": "string"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/

Create operation of resource: cfm

a1_cfm_schema

cfmbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cfg-type": "string",
            "cos7": "string",
            "cos6": "string",
            "cos5": "string",
            "cos4": "string",
            "cos3": "string",
            "cos2": "string",
            "cos1": "string",
            "cos0": "string"
          },
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mep-id": "string"
              }
            ],
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mac-address": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "mep-id": "string",
            "service": "string"
          },
          "cos": "string"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/

Delete operation of resource: cfm

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/

Retrieve operation of resource: cfm

active interface-name: string
in path

ID of active interface-name

200 OK
a1_cfm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cfg-type": "string",
            "cos7": "string",
            "cos6": "string",
            "cos5": "string",
            "cos4": "string",
            "cos3": "string",
            "cos2": "string",
            "cos1": "string",
            "cos0": "string"
          },
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mep-id": "string"
              }
            ],
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "profile": "string",
                "target-mac-address": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "mep-id": "string",
            "service": "string"
          },
          "cos": "string"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  }
}

DOMAINS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/

Update operation of resource: domains

a1_domains_schema

domainsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cfg-type": "string",
          "cos7": "string",
          "cos6": "string",
          "cos5": "string",
          "cos4": "string",
          "cos3": "string",
          "cos2": "string",
          "cos1": "string",
          "cos0": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mep-id": "string"
            }
          ],
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mac-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "mep-id": "string",
          "service": "string"
        },
        "cos": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/

Create operation of resource: domains

a1_domains_schema

domainsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cfg-type": "string",
          "cos7": "string",
          "cos6": "string",
          "cos5": "string",
          "cos4": "string",
          "cos3": "string",
          "cos2": "string",
          "cos1": "string",
          "cos0": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mep-id": "string"
            }
          ],
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mac-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "mep-id": "string",
          "service": "string"
        },
        "cos": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/

Delete operation of resource: domains

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/

Retrieve operation of resource: domains

active interface-name: string
in path

ID of active interface-name

200 OK
a1_domains_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cfg-type": "string",
          "cos7": "string",
          "cos6": "string",
          "cos5": "string",
          "cos4": "string",
          "cos3": "string",
          "cos2": "string",
          "cos1": "string",
          "cos0": "string"
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mep-id": "string"
            }
          ],
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "profile": "string",
              "target-mac-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "mep-id": "string",
          "service": "string"
        },
        "cos": "string"
      }
    }
  ]
}

DOMAIN - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/

Update operation of resource: domain

a1_domain_schema

domainbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cfg-type": "string",
      "cos7": "string",
      "cos6": "string",
      "cos5": "string",
      "cos4": "string",
      "cos3": "string",
      "cos2": "string",
      "cos1": "string",
      "cos0": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mep-id": "string"
        }
      ],
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mac-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "mep-id": "string",
      "service": "string"
    },
    "cos": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/

Create operation of resource: domain

a1_domain_schema

domainbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cfg-type": "string",
      "cos7": "string",
      "cos6": "string",
      "cos5": "string",
      "cos4": "string",
      "cos3": "string",
      "cos2": "string",
      "cos1": "string",
      "cos0": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mep-id": "string"
        }
      ],
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mac-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "mep-id": "string",
      "service": "string"
    },
    "cos": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/

Delete operation of resource: domain

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/

Retrieve operation of resource: domain

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK
a1_domain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cfg-type": "string",
      "cos7": "string",
      "cos6": "string",
      "cos5": "string",
      "cos4": "string",
      "cos3": "string",
      "cos2": "string",
      "cos1": "string",
      "cos0": "string"
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mep-id": "string"
        }
      ],
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "profile": "string",
          "target-mac-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "mep-id": "string",
      "service": "string"
    },
    "cos": "string"
  }
}

MEP - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/

Update operation of resource: mep

a1_mep_schema

mepbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/

Create operation of resource: mep

a1_mep_schema

mepbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/

Delete operation of resource: mep

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/

Retrieve operation of resource: mep

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK
a1_mep_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}

SLA-PROFILE-TARGET-MEP-IDS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/

Update operation of resource: sla-profile-target-mep-ids

a1_sla-profile-target-mep-ids_schema

sla-profile-target-mep-idsbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-IDS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/

Create operation of resource: sla-profile-target-mep-ids

a1_sla-profile-target-mep-ids_schema

sla-profile-target-mep-idsbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-IDS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/

Delete operation of resource: sla-profile-target-mep-ids

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-IDS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/

Retrieve operation of resource: sla-profile-target-mep-ids

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK
a1_sla-profile-target-mep-ids_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}

SLA-PROFILE-TARGET-MEP-ID - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mep-id/{profile target-mep-id}/

Update operation of resource: sla-profile-target-mep-id

a1_sla-profile-target-mep-id_schema

sla-profile-target-mep-idbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mep-id: string
in path

ID of profile target-mep-id

Request Content-Types: application/json
Request Example
{
  "profile": "string",
  "target-mep-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-ID - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mep-id/{profile target-mep-id}/

Create operation of resource: sla-profile-target-mep-id

a1_sla-profile-target-mep-id_schema

sla-profile-target-mep-idbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mep-id: string
in path

ID of profile target-mep-id

Request Content-Types: application/json
Request Example
{
  "profile": "string",
  "target-mep-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-ID - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mep-id/{profile target-mep-id}/

Delete operation of resource: sla-profile-target-mep-id

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mep-id: string
in path

ID of profile target-mep-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MEP-ID - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mep-id/{profile target-mep-id}/

Retrieve operation of resource: sla-profile-target-mep-id

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mep-id: string
in path

ID of profile target-mep-id

200 OK
a1_sla-profile-target-mep-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "profile": "string",
  "target-mep-id": "string"
}

SLA-PROFILE-TARGET-MAC-ADDRESS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mac-address/{profile target-mac-address}/

Update operation of resource: sla-profile-target-mac-address

a1_sla-profile-target-mac-address_schema

sla-profile-target-mac-addressbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mac-address: string
in path

ID of profile target-mac-address

Request Content-Types: application/json
Request Example
{
  "profile": "string",
  "target-mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MAC-ADDRESS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mac-address/{profile target-mac-address}/

Create operation of resource: sla-profile-target-mac-address

a1_sla-profile-target-mac-address_schema

sla-profile-target-mac-addressbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mac-address: string
in path

ID of profile target-mac-address

Request Content-Types: application/json
Request Example
{
  "profile": "string",
  "target-mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MAC-ADDRESS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mac-address/{profile target-mac-address}/

Delete operation of resource: sla-profile-target-mac-address

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mac-address: string
in path

ID of profile target-mac-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA-PROFILE-TARGET-MAC-ADDRESS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/sla-profile-target-mep-ids/sla-profile-target-mac-address/{profile target-mac-address}/

Retrieve operation of resource: sla-profile-target-mac-address

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

profile target-mac-address: string
in path

ID of profile target-mac-address

200 OK
a1_sla-profile-target-mac-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "profile": "string",
  "target-mac-address": "string"
}

MEP-PROPERTIES - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/mep-properties/

Update operation of resource: mep-properties

a1_mep-properties_schema

mep-propertiesbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "mep-id": "string",
  "service": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP-PROPERTIES - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/mep-properties/

Create operation of resource: mep-properties

a1_mep-properties_schema

mep-propertiesbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "mep-id": "string",
  "service": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP-PROPERTIES - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/mep-properties/

Delete operation of resource: mep-properties

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MEP-PROPERTIES - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/mep-properties/

Retrieve operation of resource: mep-properties

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK
a1_mep-properties_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mep-id": "string",
  "service": "string"
}

LOSS-MEASUREMENT-COUNTERS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/loss-measurement-counters/

Update operation of resource: loss-measurement-counters

a1_loss-measurement-counters_schema

loss-measurement-countersbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOSS-MEASUREMENT-COUNTERS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/loss-measurement-counters/

Create operation of resource: loss-measurement-counters

a1_loss-measurement-counters_schema

loss-measurement-countersbody object

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOSS-MEASUREMENT-COUNTERS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/loss-measurement-counters/

Delete operation of resource: loss-measurement-counters

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOSS-MEASUREMENT-COUNTERS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/domains/domain/{domain}/mep/loss-measurement-counters/

Retrieve operation of resource: loss-measurement-counters

active interface-name: string
in path

ID of active interface-name

domain: string
in path

ID of domain

200 OK
a1_loss-measurement-counters_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}

AIS-UP - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/

Update operation of resource: ais-up

a1_ais-up_schema

ais-upbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS-UP - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/

Create operation of resource: ais-up

a1_ais-up_schema

ais-upbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS-UP - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/

Delete operation of resource: ais-up

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS-UP - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/

Retrieve operation of resource: ais-up

active interface-name: string
in path

ID of active interface-name

200 OK
a1_ais-up_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}

TRANSMISSION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/transmission/

Update operation of resource: transmission

a1_transmission_schema

transmissionbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "cos": "string",
  "ais-interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/transmission/

Create operation of resource: transmission

a1_transmission_schema

transmissionbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "cos": "string",
  "ais-interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/transmission/

Delete operation of resource: transmission

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/cfm/ais-up/transmission/

Retrieve operation of resource: transmission

active interface-name: string
in path

ID of active interface-name

200 OK
a1_transmission_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "cos": "string",
  "ais-interval": "string"
}

CARRIER-DELAY - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Update operation of resource: carrier-delay

a1_carrier-delay_schema

carrier-delaybody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Create operation of resource: carrier-delay

a1_carrier-delay_schema

carrier-delaybody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Delete operation of resource: carrier-delay

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Retrieve operation of resource: carrier-delay

active interface-name: string
in path

ID of active interface-name

200 OK
a1_carrier-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}

VLAN-TRUNK-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Update operation of resource: vlan-trunk-configuration

a1_vlan-trunk-configuration_schema

vlan-trunk-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Create operation of resource: vlan-trunk-configuration

a1_vlan-trunk-configuration_schema

vlan-trunk-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Delete operation of resource: vlan-trunk-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Retrieve operation of resource: vlan-trunk-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a1_vlan-trunk-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}

NATIVE-VLAN-IDENTIFIER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Update operation of resource: native-vlan-identifier

a1_native-vlan-identifier_schema

native-vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Create operation of resource: native-vlan-identifier

a1_native-vlan-identifier_schema

native-vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Delete operation of resource: native-vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Retrieve operation of resource: native-vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK
a1_native-vlan-identifier_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}

ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Update operation of resource: ethernet-features

a2_ethernet-features_schema

ethernet-featuresbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering-default-on": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "auto": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Create operation of resource: ethernet-features

a2_ethernet-features_schema

ethernet-featuresbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering-default-on": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "auto": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Delete operation of resource: ethernet-features

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Retrieve operation of resource: ethernet-features

200 OK
a2_ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "egress-filtering-default-on": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "auto": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}

EGRESS-FILTERING - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Update operation of resource: egress-filtering

a2_egress-filtering_schema

egress-filteringbody object

Request Content-Types: application/json
Request Example
{
  "egress-filtering-default-on": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Create operation of resource: egress-filtering

a2_egress-filtering_schema

egress-filteringbody object

Request Content-Types: application/json
Request Example
{
  "egress-filtering-default-on": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Delete operation of resource: egress-filtering

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Retrieve operation of resource: egress-filtering

200 OK
a2_egress-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "egress-filtering-default-on": [ null ]
}

CFM - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/

Update operation of resource: cfm

a2_cfm_schema

cfmbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "mip-policy": "string",
                "ccm-learning-enable": [ null ]
              },
              "tags": "integer",
              "log-efd": [ null ],
              "continuity-check-archive-hold-time": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ],
                "protection-switching-enable": [ null ]
              },
              "maximum-meps": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "auto": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "mep-id": "string",
                      "enable-mac-address": [ null ],
                      "mac-address": "string"
                    }
                  ]
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "ccm-interval": "string",
                "loss-threshold": "integer"
              },
              "continuity-check-auto-traceroute": [ null ],
              "log-ais": [ null ],
              "service": "string",
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "cos": "string",
                  "ais-interval": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "evi": "integer",
                "service-type": "string",
                "short-ma-name-string": "string",
                "short-ma-name-oui": "integer",
                "switching-name": "string",
                "remote-ce-id": "integer",
                "short-ma-name-umc": "string",
                "short-ma-name-format": "string",
                "group-name": "string",
                "short-ma-name-number": "integer",
                "ce-id": "integer",
                "short-ma-name-vpn-index": "integer",
                "short-ma-name-icc": "string"
              },
              "log-cross-check-errors": [ null ],
              "log-continuity-check-errors": [ null ],
              "log-continuity-check-state-changes": [ null ]
            }
          ]
        },
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "mdid-string": "string",
          "mdid-format": "string",
          "mdid-mac-address": "string",
          "mdid-number": "integer",
          "level": "string"
        }
      }
    ]
  },
  "nv-satellite-sla-processing-disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    "cache-size": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/

Create operation of resource: cfm

a2_cfm_schema

cfmbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "mip-policy": "string",
                "ccm-learning-enable": [ null ]
              },
              "tags": "integer",
              "log-efd": [ null ],
              "continuity-check-archive-hold-time": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ],
                "protection-switching-enable": [ null ]
              },
              "maximum-meps": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "auto": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "mep-id": "string",
                      "enable-mac-address": [ null ],
                      "mac-address": "string"
                    }
                  ]
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "ccm-interval": "string",
                "loss-threshold": "integer"
              },
              "continuity-check-auto-traceroute": [ null ],
              "log-ais": [ null ],
              "service": "string",
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "cos": "string",
                  "ais-interval": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "evi": "integer",
                "service-type": "string",
                "short-ma-name-string": "string",
                "short-ma-name-oui": "integer",
                "switching-name": "string",
                "remote-ce-id": "integer",
                "short-ma-name-umc": "string",
                "short-ma-name-format": "string",
                "group-name": "string",
                "short-ma-name-number": "integer",
                "ce-id": "integer",
                "short-ma-name-vpn-index": "integer",
                "short-ma-name-icc": "string"
              },
              "log-cross-check-errors": [ null ],
              "log-continuity-check-errors": [ null ],
              "log-continuity-check-state-changes": [ null ]
            }
          ]
        },
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "mdid-string": "string",
          "mdid-format": "string",
          "mdid-mac-address": "string",
          "mdid-number": "integer",
          "level": "string"
        }
      }
    ]
  },
  "nv-satellite-sla-processing-disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    "cache-size": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/

Delete operation of resource: cfm

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/

Retrieve operation of resource: cfm

200 OK
a2_cfm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "mip-policy": "string",
                "ccm-learning-enable": [ null ]
              },
              "tags": "integer",
              "log-efd": [ null ],
              "continuity-check-archive-hold-time": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ],
                "protection-switching-enable": [ null ]
              },
              "maximum-meps": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "auto": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "mep-id": "string",
                      "enable-mac-address": [ null ],
                      "mac-address": "string"
                    }
                  ]
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "ccm-interval": "string",
                "loss-threshold": "integer"
              },
              "continuity-check-auto-traceroute": [ null ],
              "log-ais": [ null ],
              "service": "string",
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "cos": "string",
                  "ais-interval": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "evi": "integer",
                "service-type": "string",
                "short-ma-name-string": "string",
                "short-ma-name-oui": "integer",
                "switching-name": "string",
                "remote-ce-id": "integer",
                "short-ma-name-umc": "string",
                "short-ma-name-format": "string",
                "group-name": "string",
                "short-ma-name-number": "integer",
                "ce-id": "integer",
                "short-ma-name-vpn-index": "integer",
                "short-ma-name-icc": "string"
              },
              "log-cross-check-errors": [ null ],
              "log-continuity-check-errors": [ null ],
              "log-continuity-check-state-changes": [ null ]
            }
          ]
        },
        "domain": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "mdid-string": "string",
          "mdid-format": "string",
          "mdid-mac-address": "string",
          "mdid-number": "integer",
          "level": "string"
        }
      }
    ]
  },
  "nv-satellite-sla-processing-disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    "cache-size": "integer"
  }
}

TRACEROUTE-CACHE - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/traceroute-cache/

Update operation of resource: traceroute-cache

a2_traceroute-cache_schema

traceroute-cachebody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  "cache-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACEROUTE-CACHE - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/traceroute-cache/

Create operation of resource: traceroute-cache

a2_traceroute-cache_schema

traceroute-cachebody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  "cache-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACEROUTE-CACHE - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/traceroute-cache/

Delete operation of resource: traceroute-cache

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACEROUTE-CACHE - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/traceroute-cache/

Retrieve operation of resource: traceroute-cache

200 OK
a2_traceroute-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "integer",
  "cache-size": "integer"
}

DOMAINS - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/

Update operation of resource: domains

a2_domains_schema

domainsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "auto": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cos": "string",
                "ais-interval": "string"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/

Create operation of resource: domains

a2_domains_schema

domainsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "auto": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cos": "string",
                "ais-interval": "string"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/

Delete operation of resource: domains

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAINS - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/

Retrieve operation of resource: domains

200 OK
a2_domains_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "auto": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "cos": "string",
                "ais-interval": "string"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}

DOMAIN - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/

Update operation of resource: domain

a2_domain_schema

domainbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "auto": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cos": "string",
            "ais-interval": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/

Create operation of resource: domain

a2_domain_schema

domainbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "auto": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cos": "string",
            "ais-interval": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/

Delete operation of resource: domain

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/

Retrieve operation of resource: domain

domain: string
in path

ID of domain

200 OK
a2_domain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "auto": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "cos": "string",
            "ais-interval": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}

SERVICES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/

Update operation of resource: services

a2_services_schema

servicesbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "auto": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/

Create operation of resource: services

a2_services_schema

servicesbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "auto": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/

Delete operation of resource: services

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/

Retrieve operation of resource: services

domain: string
in path

ID of domain

200 OK
a2_services_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "auto": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "cos": "string",
          "ais-interval": "string"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}

SERVICE - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/

Update operation of resource: service

a2_service_schema

servicebody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "auto": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/

Create operation of resource: service

a2_service_schema

servicebody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "auto": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/

Delete operation of resource: service

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/

Retrieve operation of resource: service

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_service_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "auto": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "cos": "string",
      "ais-interval": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}

EFD2 - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/efd2/

Update operation of resource: efd2

a2_efd2_schema

efd2body object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EFD2 - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/efd2/

Create operation of resource: efd2

a2_efd2_schema

efd2body object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EFD2 - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/efd2/

Delete operation of resource: efd2

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EFD2 - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/efd2/

Retrieve operation of resource: efd2

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_efd2_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}

CONTINUITY-CHECK-INTERVAL - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/continuity-check-interval/

Update operation of resource: continuity-check-interval

a2_continuity-check-interval_schema

continuity-check-intervalbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTINUITY-CHECK-INTERVAL - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/continuity-check-interval/

Create operation of resource: continuity-check-interval

a2_continuity-check-interval_schema

continuity-check-intervalbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTINUITY-CHECK-INTERVAL - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/continuity-check-interval/

Delete operation of resource: continuity-check-interval

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTINUITY-CHECK-INTERVAL - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/continuity-check-interval/

Retrieve operation of resource: continuity-check-interval

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_continuity-check-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}

MIP-AUTO-CREATION - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/mip-auto-creation/

Update operation of resource: mip-auto-creation

a2_mip-auto-creation_schema

mip-auto-creationbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIP-AUTO-CREATION - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/mip-auto-creation/

Create operation of resource: mip-auto-creation

a2_mip-auto-creation_schema

mip-auto-creationbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIP-AUTO-CREATION - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/mip-auto-creation/

Delete operation of resource: mip-auto-creation

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIP-AUTO-CREATION - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/mip-auto-creation/

Retrieve operation of resource: mip-auto-creation

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_mip-auto-creation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}

AIS - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/

Update operation of resource: ais

a2_ais_schema

aisbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/

Create operation of resource: ais

a2_ais_schema

aisbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/

Delete operation of resource: ais

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIS - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/

Retrieve operation of resource: ais

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_ais_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "cos": "string",
    "ais-interval": "string"
  }
}

TRANSMISSION - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/transmission/

Update operation of resource: transmission

a2_transmission_schema

transmissionbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "cos": "string",
  "ais-interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/transmission/

Create operation of resource: transmission

a2_transmission_schema

transmissionbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "cos": "string",
  "ais-interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/transmission/

Delete operation of resource: transmission

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSMISSION - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/ais/transmission/

Retrieve operation of resource: transmission

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_transmission_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "cos": "string",
  "ais-interval": "string"
}

CROSS-CHECK - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/

Update operation of resource: cross-check

a2_cross-check_schema

cross-checkbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "auto": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/

Create operation of resource: cross-check

a2_cross-check_schema

cross-checkbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "auto": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/

Delete operation of resource: cross-check

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/

Retrieve operation of resource: cross-check

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_cross-check_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "auto": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}

CROSS-CHECK-MEPS - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/

Update operation of resource: cross-check-meps

a2_cross-check-meps_schema

cross-check-mepsbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEPS - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/

Create operation of resource: cross-check-meps

a2_cross-check-meps_schema

cross-check-mepsbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEPS - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/

Delete operation of resource: cross-check-meps

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEPS - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/

Retrieve operation of resource: cross-check-meps

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_cross-check-meps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}

CROSS-CHECK-MEP - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/cross-check-mep/{mep-id}/

Update operation of resource: cross-check-mep

a2_cross-check-mep_schema

cross-check-mepbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

mep-id: string
in path

ID of mep-id

Request Content-Types: application/json
Request Example
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEP - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/cross-check-mep/{mep-id}/

Create operation of resource: cross-check-mep

a2_cross-check-mep_schema

cross-check-mepbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

mep-id: string
in path

ID of mep-id

Request Content-Types: application/json
Request Example
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEP - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/cross-check-mep/{mep-id}/

Delete operation of resource: cross-check-mep

domain: string
in path

ID of domain

service: string
in path

ID of service

mep-id: string
in path

ID of mep-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CROSS-CHECK-MEP - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/cross-check/cross-check-meps/cross-check-mep/{mep-id}/

Retrieve operation of resource: cross-check-mep

domain: string
in path

ID of domain

service: string
in path

ID of service

mep-id: string
in path

ID of mep-id

200 OK
a2_cross-check-mep_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}

SERVICE-PROPERTIES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/service-properties/

Update operation of resource: service-properties

a2_service-properties_schema

service-propertiesbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE-PROPERTIES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/service-properties/

Create operation of resource: service-properties

a2_service-properties_schema

service-propertiesbody object

domain: string
in path

ID of domain

service: string
in path

ID of service

Request Content-Types: application/json
Request Example
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE-PROPERTIES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/service-properties/

Delete operation of resource: service-properties

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVICE-PROPERTIES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/services/service/{service}/service-properties/

Retrieve operation of resource: service-properties

domain: string
in path

ID of domain

service: string
in path

ID of service

200 OK
a2_service-properties_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}

DOMAIN-PROPERTIES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/domain-properties/

Update operation of resource: domain-properties

a2_domain-properties_schema

domain-propertiesbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-PROPERTIES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/domain-properties/

Create operation of resource: domain-properties

a2_domain-properties_schema

domain-propertiesbody object

domain: string
in path

ID of domain

Request Content-Types: application/json
Request Example
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-PROPERTIES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/domain-properties/

Delete operation of resource: domain-properties

domain: string
in path

ID of domain

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-PROPERTIES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/cfm/domains/domain/{domain}/domain-properties/

Retrieve operation of resource: domain-properties

domain: string
in path

ID of domain

200 OK
a2_domain-properties_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a3_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a3_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK
a3_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a3_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a3_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK
a3_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a3_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a3_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK
a3_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a3_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a3_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK
a3_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a3_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a3_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK
a3_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a3_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a3_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK
a3_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a3_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a3_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK
a3_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a3_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a3_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK
a3_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a3_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a3_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK
a3_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a3_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a3_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK
a3_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a3_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a3_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK
a3_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a3_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a3_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK
a3_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a3_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a3_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK
a3_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a3_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a3_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK
a3_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a3_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a3_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK
a3_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a3_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a3_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK
a3_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a3_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a3_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK
a3_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a3_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a3_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK
a3_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "unknown-user": [ null ]
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a3_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a3_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK
a3_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a3_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a3_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK
a3_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a3_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a3_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK
a3_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a3_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a3_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK
a3_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a3_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a3_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK
a3_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a3_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a3_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK
a3_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a3_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a3_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK
a3_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a3_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a3_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK
a3_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a3_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a3_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK
a3_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a3_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a3_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK
a3_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string"
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a3_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a3_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK
a3_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a3_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a3_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK
a3_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ip-address": "string"
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a3_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "status": [ null ],
    "full-raise": [ null ],
    "enable": [ null ],
    "full-clear": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "vc-up": [ null ],
    "vc-down": [ null ],
    "enable": [ null ],
    "cisco": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a3_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "status": [ null ],
    "full-raise": [ null ],
    "enable": [ null ],
    "full-clear": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "vc-up": [ null ],
    "vc-down": [ null ],
    "enable": [ null ],
    "cisco": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK
a3_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "status": [ null ],
    "full-raise": [ null ],
    "enable": [ null ],
    "full-clear": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "vc-up": [ null ],
    "vc-down": [ null ],
    "enable": [ null ],
    "cisco": [ null ]
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a3_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a3_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK
a3_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

VPLS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Update operation of resource: vpls

a3_vpls_schema

vplsbody object

Request Content-Types: application/json
Request Example
{
  "status": [ null ],
  "full-raise": [ null ],
  "enable": [ null ],
  "full-clear": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Create operation of resource: vpls

a3_vpls_schema

vplsbody object

Request Content-Types: application/json
Request Example
{
  "status": [ null ],
  "full-raise": [ null ],
  "enable": [ null ],
  "full-clear": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Delete operation of resource: vpls

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Retrieve operation of resource: vpls

200 OK
a3_vpls_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "status": [ null ],
  "full-raise": [ null ],
  "enable": [ null ],
  "full-clear": [ null ]
}

L2VPN - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Update operation of resource: l2vpn

a3_l2vpn_schema

l2vpnbody object

Request Content-Types: application/json
Request Example
{
  "vc-up": [ null ],
  "vc-down": [ null ],
  "enable": [ null ],
  "cisco": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Create operation of resource: l2vpn

a3_l2vpn_schema

l2vpnbody object

Request Content-Types: application/json
Request Example
{
  "vc-up": [ null ],
  "vc-down": [ null ],
  "enable": [ null ],
  "cisco": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Delete operation of resource: l2vpn

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Retrieve operation of resource: l2vpn

200 OK
a3_l2vpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vc-up": [ null ],
  "vc-down": [ null ],
  "enable": [ null ],
  "cisco": [ null ]
}

CFM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/cfm/

Update operation of resource: cfm

a3_cfm_schema

cfmbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/cfm/

Create operation of resource: cfm

a3_cfm_schema

cfmbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/cfm/

Delete operation of resource: cfm

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CFM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/cfm/

Retrieve operation of resource: cfm

200 OK
a3_cfm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a3_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a3_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK
a3_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a3_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a3_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK
a3_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a3_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a3_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

200 OK
a3_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a3_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a3_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

200 OK
a3_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a3_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a3_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a3_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a3_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a3_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a3_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a3_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a3_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a3_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a3_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a3_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a3_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a3_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a3_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

200 OK
a3_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a3_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a3_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a3_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a3_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a3_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a3_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a3_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a3_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a3_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a3_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a3_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a3_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a3_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a3_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a3_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a3_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a3_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a3_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a3_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a3_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a3_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a3_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a3_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK
a3_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a3_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a3_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

200 OK
a3_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a3_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a3_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

200 OK
a3_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a3_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a3_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK
a3_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "rulename": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a3_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a3_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a3_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a3_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a3_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a3_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a3_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a3_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a3_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a3_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a3_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK
a3_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a3_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a3_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK
a3_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a3_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a3_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK
a3_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a3_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a3_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK
a3_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a3_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a3_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK
a3_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a3_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a3_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK
a3_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a3_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a3_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK
a3_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a3_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a3_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK
a3_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a3_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a3_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK
a3_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a3_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a3_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK
a3_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a3_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a3_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK
a3_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a3_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a3_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK
a3_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string"
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a3_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a3_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK
a3_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a3_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a3_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK
a3_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a3_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a3_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK
a3_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a3_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a3_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK
a3_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a3_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a3_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK
a3_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a3_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a3_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

200 OK
a3_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a3_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a3_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
a3_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a3_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a3_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK
a3_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a3_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a3_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

200 OK
a3_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a3_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a3_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a3_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a3_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a3_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a3_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a3_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a3_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a3_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a3_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a3_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a3_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a3_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a3_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a3_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a3_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a3_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a3_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a3_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a3_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a3_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a3_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a3_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

200 OK
a3_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a3_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a3_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK
a3_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a3_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a3_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

200 OK
a3_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a3_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a3_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a3_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a3_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a3_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK
a3_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a3_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a3_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

200 OK
a3_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a3_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a3_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK
a3_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a3_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a3_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK
a3_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a3_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a3_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a3_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a3_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a3_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a3_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a3_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a3_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a3_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a3_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a3_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a3_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a3_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a3_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a3_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a3_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a3_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a3_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a3_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a3_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a3_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a3_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a3_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a3_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK
a3_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a3_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a3_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

200 OK
a3_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a3_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a3_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK
a3_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a3_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a3_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a3_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a3_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a3_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK
a3_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

SLA - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/

Update operation of resource: sla

a4_sla_schema

slabody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "buckets-size": "integer",
                    "buckets-size-unit": "string"
                  },
                  "enable": [ null ],
                  "buckets-archive": "integer",
                  "statistic-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "bins-count": "integer",
                    "bins-width": "integer",
                    "bins-width-tenths": "integer"
                  }
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "priority": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "padding-type": "string",
                "padding-value": "string",
                "size": "integer"
              },
              : { 
PUT                POST               DELETE              GET              
              
                "burst-interval-unit": "string",
                "send-type": "string",
                "packet-interval": "integer",
                "burst-interval": "integer",
                "packet-count": "integer",
                "packet-interval-unit": "string"
              },
              "synthetic-loss-calculation-packets": "integer"
            },
            "profile-name": "string",
            "packet-type": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "probe-duration": "integer",
              "probe-interval": "integer",
              "probe-duration-unit": "string",
              "start-time-hour": "integer",
              "probe-interval-unit": "string",
              "start-time-minute": "integer",
              "probe-interval-day": "string",
              "start-time-second": "integer"
            }
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/

Create operation of resource: sla

a4_sla_schema

slabody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "buckets-size": "integer",
                    "buckets-size-unit": "string"
                  },
                  "enable": [ null ],
                  "buckets-archive": "integer",
                  "statistic-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "bins-count": "integer",
                    "bins-width": "integer",
                    "bins-width-tenths": "integer"
                  }
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "priority": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "padding-type": "string",
                "padding-value": "string",
                "size": "integer"
              },
              : { 
PUT                POST               DELETE              GET              
              
                "burst-interval-unit": "string",
                "send-type": "string",
                "packet-interval": "integer",
                "burst-interval": "integer",
                "packet-count": "integer",
                "packet-interval-unit": "string"
              },
              "synthetic-loss-calculation-packets": "integer"
            },
            "profile-name": "string",
            "packet-type": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "probe-duration": "integer",
              "probe-interval": "integer",
              "probe-duration-unit": "string",
              "start-time-hour": "integer",
              "probe-interval-unit": "string",
              "start-time-minute": "integer",
              "probe-interval-day": "string",
              "start-time-second": "integer"
            }
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/

Delete operation of resource: sla

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLA - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/

Retrieve operation of resource: sla

200 OK
a4_sla_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "buckets-size": "integer",
                    "buckets-size-unit": "string"
                  },
                  "enable": [ null ],
                  "buckets-archive": "integer",
                  "statistic-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "bins-count": "integer",
                    "bins-width": "integer",
                    "bins-width-tenths": "integer"
                  }
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "priority": "integer",
              : { 
PUT                POST               DELETE              GET              
              
                "padding-type": "string",
                "padding-value": "string",
                "size": "integer"
              },
              : { 
PUT                POST               DELETE              GET              
              
                "burst-interval-unit": "string",
                "send-type": "string",
                "packet-interval": "integer",
                "burst-interval": "integer",
                "packet-count": "integer",
                "packet-interval-unit": "string"
              },
              "synthetic-loss-calculation-packets": "integer"
            },
            "profile-name": "string",
            "packet-type": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "probe-duration": "integer",
              "probe-interval": "integer",
              "probe-duration-unit": "string",
              "start-time-hour": "integer",
              "probe-interval-unit": "string",
              "start-time-minute": "integer",
              "probe-interval-day": "string",
              "start-time-second": "integer"
            }
          }
        ]
      }
    }
  }
}

PROTOCOLS - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/

Update operation of resource: protocols

a4_protocols_schema

protocolsbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "buckets-size": "integer",
                  "buckets-size-unit": "string"
                },
                "enable": [ null ],
                "buckets-archive": "integer",
                "statistic-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "bins-count": "integer",
                  "bins-width": "integer",
                  "bins-width-tenths": "integer"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "priority": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "padding-type": "string",
              "padding-value": "string",
              "size": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "burst-interval-unit": "string",
              "send-type": "string",
              "packet-interval": "integer",
              "burst-interval": "integer",
              "packet-count": "integer",
              "packet-interval-unit": "string"
            },
            "synthetic-loss-calculation-packets": "integer"
          },
          "profile-name": "string",
          "packet-type": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "probe-duration": "integer",
            "probe-interval": "integer",
            "probe-duration-unit": "string",
            "start-time-hour": "integer",
            "probe-interval-unit": "string",
            "start-time-minute": "integer",
            "probe-interval-day": "string",
            "start-time-second": "integer"
          }
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTOCOLS - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/

Create operation of resource: protocols

a4_protocols_schema

protocolsbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "buckets-size": "integer",
                  "buckets-size-unit": "string"
                },
                "enable": [ null ],
                "buckets-archive": "integer",
                "statistic-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "bins-count": "integer",
                  "bins-width": "integer",
                  "bins-width-tenths": "integer"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "priority": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "padding-type": "string",
              "padding-value": "string",
              "size": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "burst-interval-unit": "string",
              "send-type": "string",
              "packet-interval": "integer",
              "burst-interval": "integer",
              "packet-count": "integer",
              "packet-interval-unit": "string"
            },
            "synthetic-loss-calculation-packets": "integer"
          },
          "profile-name": "string",
          "packet-type": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "probe-duration": "integer",
            "probe-interval": "integer",
            "probe-duration-unit": "string",
            "start-time-hour": "integer",
            "probe-interval-unit": "string",
            "start-time-minute": "integer",
            "probe-interval-day": "string",
            "start-time-second": "integer"
          }
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTOCOLS - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/

Delete operation of resource: protocols

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTOCOLS - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/

Retrieve operation of resource: protocols

200 OK
a4_protocols_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                : { 
PUT                  POST                 DELETE                GET                
                
                  "buckets-size": "integer",
                  "buckets-size-unit": "string"
                },
                "enable": [ null ],
                "buckets-archive": "integer",
                "statistic-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "bins-count": "integer",
                  "bins-width": "integer",
                  "bins-width-tenths": "integer"
                }
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "priority": "integer",
            : { 
PUT              POST             DELETE            GET            
            
              "padding-type": "string",
              "padding-value": "string",
              "size": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "burst-interval-unit": "string",
              "send-type": "string",
              "packet-interval": "integer",
              "burst-interval": "integer",
              "packet-count": "integer",
              "packet-interval-unit": "string"
            },
            "synthetic-loss-calculation-packets": "integer"
          },
          "profile-name": "string",
          "packet-type": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "probe-duration": "integer",
            "probe-interval": "integer",
            "probe-duration-unit": "string",
            "start-time-hour": "integer",
            "probe-interval-unit": "string",
            "start-time-minute": "integer",
            "probe-interval-day": "string",
            "start-time-second": "integer"
          }
        }
      ]
    }
  }
}

ETHERNET - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/

Update operation of resource: ethernet

a4_ethernet_schema

ethernetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "buckets-size": "integer",
                "buckets-size-unit": "string"
              },
              "enable": [ null ],
              "buckets-archive": "integer",
              "statistic-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "bins-count": "integer",
                "bins-width": "integer",
                "bins-width-tenths": "integer"
              }
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "priority": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "padding-type": "string",
            "padding-value": "string",
            "size": "integer"
          },
          : { 
PUT            POST           DELETE          GET          
          
            "burst-interval-unit": "string",
            "send-type": "string",
            "packet-interval": "integer",
            "burst-interval": "integer",
            "packet-count": "integer",
            "packet-interval-unit": "string"
          },
          "synthetic-loss-calculation-packets": "integer"
        },
        "profile-name": "string",
        "packet-type": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "probe-duration": "integer",
          "probe-interval": "integer",
          "probe-duration-unit": "string",
          "start-time-hour": "integer",
          "probe-interval-unit": "string",
          "start-time-minute": "integer",
          "probe-interval-day": "string",
          "start-time-second": "integer"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/

Create operation of resource: ethernet

a4_ethernet_schema

ethernetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "buckets-size": "integer",
                "buckets-size-unit": "string"
              },
              "enable": [ null ],
              "buckets-archive": "integer",
              "statistic-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "bins-count": "integer",
                "bins-width": "integer",
                "bins-width-tenths": "integer"
              }
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "priority": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "padding-type": "string",
            "padding-value": "string",
            "size": "integer"
          },
          : { 
PUT            POST           DELETE          GET          
          
            "burst-interval-unit": "string",
            "send-type": "string",
            "packet-interval": "integer",
            "burst-interval": "integer",
            "packet-count": "integer",
            "packet-interval-unit": "string"
          },
          "synthetic-loss-calculation-packets": "integer"
        },
        "profile-name": "string",
        "packet-type": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "probe-duration": "integer",
          "probe-interval": "integer",
          "probe-duration-unit": "string",
          "start-time-hour": "integer",
          "probe-interval-unit": "string",
          "start-time-minute": "integer",
          "probe-interval-day": "string",
          "start-time-second": "integer"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/

Delete operation of resource: ethernet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/

Retrieve operation of resource: ethernet

200 OK
a4_ethernet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              : { 
PUT                POST               DELETE              GET              
              
                "buckets-size": "integer",
                "buckets-size-unit": "string"
              },
              "enable": [ null ],
              "buckets-archive": "integer",
              "statistic-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "bins-count": "integer",
                "bins-width": "integer",
                "bins-width-tenths": "integer"
              }
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "priority": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "padding-type": "string",
            "padding-value": "string",
            "size": "integer"
          },
          : { 
PUT            POST           DELETE          GET          
          
            "burst-interval-unit": "string",
            "send-type": "string",
            "packet-interval": "integer",
            "burst-interval": "integer",
            "packet-count": "integer",
            "packet-interval-unit": "string"
          },
          "synthetic-loss-calculation-packets": "integer"
        },
        "profile-name": "string",
        "packet-type": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "probe-duration": "integer",
          "probe-interval": "integer",
          "probe-duration-unit": "string",
          "start-time-hour": "integer",
          "probe-interval-unit": "string",
          "start-time-minute": "integer",
          "probe-interval-day": "string",
          "start-time-second": "integer"
        }
      }
    ]
  }
}

PROFILES - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/

Update operation of resource: profiles

a4_profiles_schema

profilesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "buckets-size": "integer",
              "buckets-size-unit": "string"
            },
            "enable": [ null ],
            "buckets-archive": "integer",
            "statistic-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "bins-count": "integer",
              "bins-width": "integer",
              "bins-width-tenths": "integer"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "priority": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "padding-type": "string",
          "padding-value": "string",
          "size": "integer"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "burst-interval-unit": "string",
          "send-type": "string",
          "packet-interval": "integer",
          "burst-interval": "integer",
          "packet-count": "integer",
          "packet-interval-unit": "string"
        },
        "synthetic-loss-calculation-packets": "integer"
      },
      "profile-name": "string",
      "packet-type": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "probe-duration": "integer",
        "probe-interval": "integer",
        "probe-duration-unit": "string",
        "start-time-hour": "integer",
        "probe-interval-unit": "string",
        "start-time-minute": "integer",
        "probe-interval-day": "string",
        "start-time-second": "integer"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/

Create operation of resource: profiles

a4_profiles_schema

profilesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "buckets-size": "integer",
              "buckets-size-unit": "string"
            },
            "enable": [ null ],
            "buckets-archive": "integer",
            "statistic-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "bins-count": "integer",
              "bins-width": "integer",
              "bins-width-tenths": "integer"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "priority": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "padding-type": "string",
          "padding-value": "string",
          "size": "integer"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "burst-interval-unit": "string",
          "send-type": "string",
          "packet-interval": "integer",
          "burst-interval": "integer",
          "packet-count": "integer",
          "packet-interval-unit": "string"
        },
        "synthetic-loss-calculation-packets": "integer"
      },
      "profile-name": "string",
      "packet-type": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "probe-duration": "integer",
        "probe-interval": "integer",
        "probe-duration-unit": "string",
        "start-time-hour": "integer",
        "probe-interval-unit": "string",
        "start-time-minute": "integer",
        "probe-interval-day": "string",
        "start-time-second": "integer"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/

Delete operation of resource: profiles

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/

Retrieve operation of resource: profiles

200 OK
a4_profiles_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : { 
PUT              POST             DELETE            GET            
            
              "buckets-size": "integer",
              "buckets-size-unit": "string"
            },
            "enable": [ null ],
            "buckets-archive": "integer",
            "statistic-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "bins-count": "integer",
              "bins-width": "integer",
              "bins-width-tenths": "integer"
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "priority": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          "padding-type": "string",
          "padding-value": "string",
          "size": "integer"
        },
        : { 
PUT          POST         DELETE        GET        
        
          "burst-interval-unit": "string",
          "send-type": "string",
          "packet-interval": "integer",
          "burst-interval": "integer",
          "packet-count": "integer",
          "packet-interval-unit": "string"
        },
        "synthetic-loss-calculation-packets": "integer"
      },
      "profile-name": "string",
      "packet-type": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "probe-duration": "integer",
        "probe-interval": "integer",
        "probe-duration-unit": "string",
        "start-time-hour": "integer",
        "probe-interval-unit": "string",
        "start-time-minute": "integer",
        "probe-interval-day": "string",
        "start-time-second": "integer"
      }
    }
  ]
}

PROFILE - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/

Update operation of resource: profile

a4_profile_schema

profilebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "buckets-size": "integer",
          "buckets-size-unit": "string"
        },
        "enable": [ null ],
        "buckets-archive": "integer",
        "statistic-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "bins-count": "integer",
          "bins-width": "integer",
          "bins-width-tenths": "integer"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "priority": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "padding-type": "string",
      "padding-value": "string",
      "size": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "burst-interval-unit": "string",
      "send-type": "string",
      "packet-interval": "integer",
      "burst-interval": "integer",
      "packet-count": "integer",
      "packet-interval-unit": "string"
    },
    "synthetic-loss-calculation-packets": "integer"
  },
  "profile-name": "string",
  "packet-type": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "probe-duration": "integer",
    "probe-interval": "integer",
    "probe-duration-unit": "string",
    "start-time-hour": "integer",
    "probe-interval-unit": "string",
    "start-time-minute": "integer",
    "probe-interval-day": "string",
    "start-time-second": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/

Create operation of resource: profile

a4_profile_schema

profilebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "buckets-size": "integer",
          "buckets-size-unit": "string"
        },
        "enable": [ null ],
        "buckets-archive": "integer",
        "statistic-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "bins-count": "integer",
          "bins-width": "integer",
          "bins-width-tenths": "integer"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "priority": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "padding-type": "string",
      "padding-value": "string",
      "size": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "burst-interval-unit": "string",
      "send-type": "string",
      "packet-interval": "integer",
      "burst-interval": "integer",
      "packet-count": "integer",
      "packet-interval-unit": "string"
    },
    "synthetic-loss-calculation-packets": "integer"
  },
  "profile-name": "string",
  "packet-type": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "probe-duration": "integer",
    "probe-interval": "integer",
    "probe-duration-unit": "string",
    "start-time-hour": "integer",
    "probe-interval-unit": "string",
    "start-time-minute": "integer",
    "probe-interval-day": "string",
    "start-time-second": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/

Delete operation of resource: profile

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/

Retrieve operation of resource: profile

profile-name: string
in path

ID of profile-name

200 OK
a4_profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          "buckets-size": "integer",
          "buckets-size-unit": "string"
        },
        "enable": [ null ],
        "buckets-archive": "integer",
        "statistic-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "bins-count": "integer",
          "bins-width": "integer",
          "bins-width-tenths": "integer"
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "priority": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "padding-type": "string",
      "padding-value": "string",
      "size": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "burst-interval-unit": "string",
      "send-type": "string",
      "packet-interval": "integer",
      "burst-interval": "integer",
      "packet-count": "integer",
      "packet-interval-unit": "string"
    },
    "synthetic-loss-calculation-packets": "integer"
  },
  "profile-name": "string",
  "packet-type": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "probe-duration": "integer",
    "probe-interval": "integer",
    "probe-duration-unit": "string",
    "start-time-hour": "integer",
    "probe-interval-unit": "string",
    "start-time-minute": "integer",
    "probe-interval-day": "string",
    "start-time-second": "integer"
  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/

Update operation of resource: statistics

a4_statistics_schema

statisticsbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "buckets-size": "integer",
        "buckets-size-unit": "string"
      },
      "enable": [ null ],
      "buckets-archive": "integer",
      "statistic-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "bins-count": "integer",
        "bins-width": "integer",
        "bins-width-tenths": "integer"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/

Create operation of resource: statistics

a4_statistics_schema

statisticsbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "buckets-size": "integer",
        "buckets-size-unit": "string"
      },
      "enable": [ null ],
      "buckets-archive": "integer",
      "statistic-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "bins-count": "integer",
        "bins-width": "integer",
        "bins-width-tenths": "integer"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/

Delete operation of resource: statistics

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/

Retrieve operation of resource: statistics

profile-name: string
in path

ID of profile-name

200 OK
a4_statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        "buckets-size": "integer",
        "buckets-size-unit": "string"
      },
      "enable": [ null ],
      "buckets-archive": "integer",
      "statistic-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "bins-count": "integer",
        "bins-width": "integer",
        "bins-width-tenths": "integer"
      }
    }
  ]
}

STATISTIC - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/

Update operation of resource: statistic

a4_statistic_schema

statisticbody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "buckets-size": "integer",
    "buckets-size-unit": "string"
  },
  "enable": [ null ],
  "buckets-archive": "integer",
  "statistic-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "bins-count": "integer",
    "bins-width": "integer",
    "bins-width-tenths": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTIC - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/

Create operation of resource: statistic

a4_statistic_schema

statisticbody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "buckets-size": "integer",
    "buckets-size-unit": "string"
  },
  "enable": [ null ],
  "buckets-archive": "integer",
  "statistic-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "bins-count": "integer",
    "bins-width": "integer",
    "bins-width-tenths": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTIC - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/

Delete operation of resource: statistic

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTIC - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/

Retrieve operation of resource: statistic

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK
a4_statistic_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "buckets-size": "integer",
    "buckets-size-unit": "string"
  },
  "enable": [ null ],
  "buckets-archive": "integer",
  "statistic-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "bins-count": "integer",
    "bins-width": "integer",
    "bins-width-tenths": "integer"
  }
}

BUCKETS-SIZE - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/buckets-size/

Update operation of resource: buckets-size

a4_buckets-size_schema

buckets-sizebody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  "buckets-size": "integer",
  "buckets-size-unit": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BUCKETS-SIZE - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/buckets-size/

Create operation of resource: buckets-size

a4_buckets-size_schema

buckets-sizebody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  "buckets-size": "integer",
  "buckets-size-unit": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BUCKETS-SIZE - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/buckets-size/

Delete operation of resource: buckets-size

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BUCKETS-SIZE - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/buckets-size/

Retrieve operation of resource: buckets-size

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK
a4_buckets-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "buckets-size": "integer",
  "buckets-size-unit": "string"
}

AGGREGATION - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/aggregation/

Update operation of resource: aggregation

a4_aggregation_schema

aggregationbody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  "bins-count": "integer",
  "bins-width": "integer",
  "bins-width-tenths": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATION - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/aggregation/

Create operation of resource: aggregation

a4_aggregation_schema

aggregationbody object

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

Request Content-Types: application/json
Request Example
{
  "bins-count": "integer",
  "bins-width": "integer",
  "bins-width-tenths": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATION - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/aggregation/

Delete operation of resource: aggregation

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATION - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/statistics/statistic/{statistic-name}/aggregation/

Retrieve operation of resource: aggregation

profile-name: string
in path

ID of profile-name

statistic-name: string
in path

ID of statistic-name

200 OK
a4_aggregation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "bins-count": "integer",
  "bins-width": "integer",
  "bins-width-tenths": "integer"
}

SCHEDULE - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/schedule/

Update operation of resource: schedule

a4_schedule_schema

schedulebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "probe-duration": "integer",
  "probe-interval": "integer",
  "probe-duration-unit": "string",
  "start-time-hour": "integer",
  "probe-interval-unit": "string",
  "start-time-minute": "integer",
  "probe-interval-day": "string",
  "start-time-second": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/schedule/

Create operation of resource: schedule

a4_schedule_schema

schedulebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "probe-duration": "integer",
  "probe-interval": "integer",
  "probe-duration-unit": "string",
  "start-time-hour": "integer",
  "probe-interval-unit": "string",
  "start-time-minute": "integer",
  "probe-interval-day": "string",
  "start-time-second": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/schedule/

Delete operation of resource: schedule

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/schedule/

Retrieve operation of resource: schedule

profile-name: string
in path

ID of profile-name

200 OK
a4_schedule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "probe-duration": "integer",
  "probe-interval": "integer",
  "probe-duration-unit": "string",
  "start-time-hour": "integer",
  "probe-interval-unit": "string",
  "start-time-minute": "integer",
  "probe-interval-day": "string",
  "start-time-second": "integer"
}

PROBE - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/

Update operation of resource: probe

a4_probe_schema

probebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "padding-type": "string",
    "padding-value": "string",
    "size": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "burst-interval-unit": "string",
    "send-type": "string",
    "packet-interval": "integer",
    "burst-interval": "integer",
    "packet-count": "integer",
    "packet-interval-unit": "string"
  },
  "synthetic-loss-calculation-packets": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROBE - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/

Create operation of resource: probe

a4_probe_schema

probebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "padding-type": "string",
    "padding-value": "string",
    "size": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "burst-interval-unit": "string",
    "send-type": "string",
    "packet-interval": "integer",
    "burst-interval": "integer",
    "packet-count": "integer",
    "packet-interval-unit": "string"
  },
  "synthetic-loss-calculation-packets": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROBE - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/

Delete operation of resource: probe

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROBE - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/

Retrieve operation of resource: probe

profile-name: string
in path

ID of profile-name

200 OK
a4_probe_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priority": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "padding-type": "string",
    "padding-value": "string",
    "size": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "burst-interval-unit": "string",
    "send-type": "string",
    "packet-interval": "integer",
    "burst-interval": "integer",
    "packet-count": "integer",
    "packet-interval-unit": "string"
  },
  "synthetic-loss-calculation-packets": "integer"
}

SEND - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/send/

Update operation of resource: send

a4_send_schema

sendbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "burst-interval-unit": "string",
  "send-type": "string",
  "packet-interval": "integer",
  "burst-interval": "integer",
  "packet-count": "integer",
  "packet-interval-unit": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/send/

Create operation of resource: send

a4_send_schema

sendbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "burst-interval-unit": "string",
  "send-type": "string",
  "packet-interval": "integer",
  "burst-interval": "integer",
  "packet-count": "integer",
  "packet-interval-unit": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/send/

Delete operation of resource: send

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/send/

Retrieve operation of resource: send

profile-name: string
in path

ID of profile-name

200 OK
a4_send_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "burst-interval-unit": "string",
  "send-type": "string",
  "packet-interval": "integer",
  "burst-interval": "integer",
  "packet-count": "integer",
  "packet-interval-unit": "string"
}

PACKET-SIZE-AND-PADDING - Update

PUT Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/packet-size-and-padding/

Update operation of resource: packet-size-and-padding

a4_packet-size-and-padding_schema

packet-size-and-paddingbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "padding-type": "string",
  "padding-value": "string",
  "size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-SIZE-AND-PADDING - Create

POST Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/packet-size-and-padding/

Create operation of resource: packet-size-and-padding

a4_packet-size-and-padding_schema

packet-size-and-paddingbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "padding-type": "string",
  "padding-value": "string",
  "size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-SIZE-AND-PADDING - Delete

DELETE Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/packet-size-and-padding/

Delete operation of resource: packet-size-and-padding

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-SIZE-AND-PADDING - Retrieve

GET Cisco-IOS-XR-infra-sla-cfg:sla/protocols/ethernet/profiles/profile/{profile-name}/probe/packet-size-and-padding/

Retrieve operation of resource: packet-size-and-padding

profile-name: string
in path

ID of profile-name

200 OK
a4_packet-size-and-padding_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "padding-type": "string",
  "padding-value": "string",
  "size": "integer"
}

Schema Definitions

a1_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces

Enable or disable link-status messages

Example
{
  "link-status": "string"
}

a1_interface-configurations_schema:

interface configurations

interface-configuration: object[]

The configuration for an interface

object
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-configuration": [
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      "mac-accounting": {
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      "ethernet-features": {
        "filtering": "string",
        "cfm": {
          "domains": {
            "domain": [
              {
                "domain": "string",
                "mep": {
                  "loss-measurement-counters": {
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  "sla-profile-target-mep-ids": {
                    "sla-profile-target-mep-id": [
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    "sla-profile-target-mac-address": [
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  "mep-properties": {
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          "ais-up": {
            "transmission": {
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      "vlan-trunk-configuration": {
        "native-vlan-identifier": {
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "bvi": {
        "host-routing": [ null ]
      },
      "carrier-delay": {
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      "vlan-sub-configuration": {
        "vlan-identifier": {
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      "l2-transport": {
        "propagate-remote-status": [ null ],
        "l2-protocols": {
          "l2-protocol": [
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        "l2-ethernet-features": {
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      "pseudowire-iw": {
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      "ethernet-service": {
        "local-traffic-default-encapsulation": {
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        "rewrite": {
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string",
          "outer-tag-type": "string"
        }
      }
    }
  ]
}

a1_interface-configuration_schema:

interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  "mac-accounting": {
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  "ethernet-features": {
    "filtering": "string",
    "cfm": {
      "domains": {
        "domain": [
          {
            "domain": "string",
            "mep": {
              "loss-measurement-counters": {
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              "sla-profile-target-mep-ids": {
                "sla-profile-target-mep-id": [
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                "sla-profile-target-mac-address": [
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              "mep-properties": {
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      "ais-up": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  "vlan-trunk-configuration": {
    "native-vlan-identifier": {
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "bvi": {
    "host-routing": [ null ]
  },
  "carrier-delay": {
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  "vlan-sub-configuration": {
    "vlan-identifier": {
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  "l2-transport": {
    "propagate-remote-status": [ null ],
    "l2-protocols": {
      "l2-protocol": [
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    "l2-ethernet-features": {
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  "pseudowire-iw": {
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  "ethernet-service": {
    "local-traffic-default-encapsulation": {
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    "rewrite": {
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    "encapsulation": {
      "ingress-destination-mac": "string"
    }
  }
}

a1_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a1_mtus_schema:

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a1_mtu_schema:

owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "owner": "string",
  "mtu": "integer"
}

a1_encapsulation_schema:

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a1_pseudowire-ether_schema:

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}

a1_pseudowire-iw_schema:

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}

a1_bvi_schema:

BVI attributes

host-routing: null

Enable host-routing on this BVI

Example
{
  "host-routing": [ null ]
}

a1_l2-transport_schema:

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "propagate-remote-status": [ null ],
  "l2-protocols": {
    "l2-protocol": [
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  "l2-ethernet-features": {
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}

a1_l2-protocols_schema:

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "l2-protocol": [
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}

a1_l2-protocol_schema:

mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}

a1_l2-ethernet-features_schema:

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}

a1_vlan-sub-configuration_schema:

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-identifier": {
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}

a1_vlan-identifier_schema:

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}

a1_ethernet-service_schema:

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "local-traffic-default-encapsulation": {
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  "rewrite": {
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  "encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a1_local-traffic-default-encapsulation_schema:

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}

a1_rewrite_schema:

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}

a1_ethernet-bng_schema:

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ambiguous-encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a1_ambiguous-encapsulation_schema:

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a1_mac-accounting_schema:

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

Example
{
  "ingress": [ null ],
  "egress": [ null ]
}

a1_ethernet-features_schema:

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "filtering": "string",
  "cfm": {
    "domains": {
      "domain": [
        {
          "domain": "string",
          "mep": {
            "loss-measurement-counters": {
              "cfg-type": "string",
              "cos7": "string",
              "cos6": "string",
              "cos5": "string",
              "cos4": "string",
              "cos3": "string",
              "cos2": "string",
              "cos1": "string",
              "cos0": "string"
            },
            "sla-profile-target-mep-ids": {
              "sla-profile-target-mep-id": [
                {
                  "profile": "string",
                  "target-mep-id": "string"
                }
              ],
              "sla-profile-target-mac-address": [
                {
                  "profile": "string",
                  "target-mac-address": "string"
                }
              ]
            },
            "mep-properties": {
              "mep-id": "string",
              "service": "string"
            },
            "cos": "string"
          }
        }
      ]
    },
    "ais-up": {
      "transmission": {
        "cos": "string",
        "ais-interval": "string"
      }
    }
  }
}

a1_cfm_schema:

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "domains": {
    "domain": [
      {
        "domain": "string",
        "mep": {
          "loss-measurement-counters": {
            "cfg-type": "string",
            "cos7": "string",
            "cos6": "string",
            "cos5": "string",
            "cos4": "string",
            "cos3": "string",
            "cos2": "string",
            "cos1": "string",
            "cos0": "string"
          },
          "sla-profile-target-mep-ids": {
            "sla-profile-target-mep-id": [
              {
                "profile": "string",
                "target-mep-id": "string"
              }
            ],
            "sla-profile-target-mac-address": [
              {
                "profile": "string",
                "target-mac-address": "string"
              }
            ]
          },
          "mep-properties": {
            "mep-id": "string",
            "service": "string"
          },
          "cos": "string"
        }
      }
    ]
  },
  "ais-up": {
    "transmission": {
      "cos": "string",
      "ais-interval": "string"
    }
  }
}

a1_domains_schema:

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "domain": [
    {
      "domain": "string",
      "mep": {
        "loss-measurement-counters": {
          "cfg-type": "string",
          "cos7": "string",
          "cos6": "string",
          "cos5": "string",
          "cos4": "string",
          "cos3": "string",
          "cos2": "string",
          "cos1": "string",
          "cos0": "string"
        },
        "sla-profile-target-mep-ids": {
          "sla-profile-target-mep-id": [
            {
              "profile": "string",
              "target-mep-id": "string"
            }
          ],
          "sla-profile-target-mac-address": [
            {
              "profile": "string",
              "target-mac-address": "string"
            }
          ]
        },
        "mep-properties": {
          "mep-id": "string",
          "service": "string"
        },
        "cos": "string"
      }
    }
  ]
}

a1_domain_schema:

domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "domain": "string",
  "mep": {
    "loss-measurement-counters": {
      "cfg-type": "string",
      "cos7": "string",
      "cos6": "string",
      "cos5": "string",
      "cos4": "string",
      "cos3": "string",
      "cos2": "string",
      "cos1": "string",
      "cos0": "string"
    },
    "sla-profile-target-mep-ids": {
      "sla-profile-target-mep-id": [
        {
          "profile": "string",
          "target-mep-id": "string"
        }
      ],
      "sla-profile-target-mac-address": [
        {
          "profile": "string",
          "target-mac-address": "string"
        }
      ]
    },
    "mep-properties": {
      "mep-id": "string",
      "service": "string"
    },
    "cos": "string"
  }
}

a1_mep_schema:

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "loss-measurement-counters": {
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  "sla-profile-target-mep-ids": {
    "sla-profile-target-mep-id": [
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    "sla-profile-target-mac-address": [
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  "mep-properties": {
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}

a1_sla-profile-target-mep-ids_schema:

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "sla-profile-target-mep-id": [
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  "sla-profile-target-mac-address": [
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}

a1_sla-profile-target-mep-id_schema:

profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

Example
{
  "profile": "string",
  "target-mep-id": "string"
}

a1_sla-profile-target-mac-address_schema:

profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "profile": "string",
  "target-mac-address": "string"
}

a1_mep-properties_schema:

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

Example
{
  "mep-id": "string",
  "service": "string"
}

a1_loss-measurement-counters_schema:

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}

a1_ais-up_schema:

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a1_transmission_schema:

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "cos": "string",
  "ais-interval": "string"
}

a1_carrier-delay_schema:

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}

a1_vlan-trunk-configuration_schema:

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

Example
{
  "native-vlan-identifier": {
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}

a1_native-vlan-identifier_schema:

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}

a2_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces

Enable or disable link-status messages

Example
{
  "link-status": "string"
}

a2_interface-configurations_schema:

interface configurations

interface-configuration: object[]

The configuration for an interface

object
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-configuration": [
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      "mac-accounting": {
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      "ethernet-features": {
        "filtering": "string",
        "cfm": {
          "domains": {
            "domain": [
              {
                "domain": "string",
                "mep": {
                  "loss-measurement-counters": {
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  "sla-profile-target-mep-ids": {
                    "sla-profile-target-mep-id": [
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    "sla-profile-target-mac-address": [
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  "mep-properties": {
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          "ais-up": {
            "transmission": {
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      "vlan-trunk-configuration": {
        "native-vlan-identifier": {
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "bvi": {
        "host-routing": [ null ]
      },
      "carrier-delay": {
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      "vlan-sub-configuration": {
        "vlan-identifier": {
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      "l2-transport": {
        "propagate-remote-status": [ null ],
        "l2-protocols": {
          "l2-protocol": [
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        "l2-ethernet-features": {
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      "pseudowire-iw": {
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      "ethernet-service": {
        "local-traffic-default-encapsulation": {
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        "rewrite": {
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string",
          "outer-tag-type": "string"
        }
      }
    }
  ]
}

a2_interface-configuration_schema:

interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  "mac-accounting": {
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  "ethernet-features": {
    "filtering": "string",
    "cfm": {
      "domains": {
        "domain": [
          {
            "domain": "string",
            "mep": {
              "loss-measurement-counters": {
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              "sla-profile-target-mep-ids": {
                "sla-profile-target-mep-id": [
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                "sla-profile-target-mac-address": [
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              "mep-properties": {
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      "ais-up": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  "vlan-trunk-configuration": {
    "native-vlan-identifier": {
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "bvi": {
    "host-routing": [ null ]
  },
  "carrier-delay": {
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  "vlan-sub-configuration": {
    "vlan-identifier": {
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  "l2-transport": {
    "propagate-remote-status": [ null ],
    "l2-protocols": {
      "l2-protocol": [
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    "l2-ethernet-features": {
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  "pseudowire-iw": {
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  "ethernet-service": {
    "local-traffic-default-encapsulation": {
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    "rewrite": {
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    "encapsulation": {
      "ingress-destination-mac": "string"
    }
  }
}

a2_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a2_mtus_schema:

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a2_mtu_schema:

owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "owner": "string",
  "mtu": "integer"
}

a2_encapsulation_schema:

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a2_pseudowire-ether_schema:

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}

a2_pseudowire-iw_schema:

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}

a2_bvi_schema:

BVI attributes

host-routing: null

Enable host-routing on this BVI

Example
{
  "host-routing": [ null ]
}

a2_l2-transport_schema:

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "propagate-remote-status": [ null ],
  "l2-protocols": {
    "l2-protocol": [
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  "l2-ethernet-features": {
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}

a2_l2-protocols_schema:

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "l2-protocol": [
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}

a2_l2-protocol_schema:

mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}

a2_l2-ethernet-features_schema:

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}

a2_vlan-sub-configuration_schema:

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-identifier": {
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}

a2_vlan-identifier_schema:

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}

a2_ethernet-service_schema:

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "local-traffic-default-encapsulation": {
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  "rewrite": {
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  "encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a2_local-traffic-default-encapsulation_schema:

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}

a2_rewrite_schema:

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}

a2_ethernet-bng_schema:

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ambiguous-encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a2_ambiguous-encapsulation_schema:

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a2_mac-accounting_schema:

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

Example
{
  "ingress": [ null ],
  "egress": [ null ]
}

a2_ethernet-features_schema:

Ethernet Features Configuration

egress-filtering: object

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

cfm: object

CFM global configuration

domains: object

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

nv-satellite-sla-processing-disable: null

Disable processing of Ethernet SLA packets on nV Satellite devices

traceroute-cache: object

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "egress-filtering": {
    "egress-filtering-default-on": [ null ]
  },
  "cfm": {
    "domains": {
      "domain": [
        {
          "services": {
            "service": [
              {
                "mip-auto-creation": {
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                "efd2": {
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                "cross-check": {
                  "auto": [ null ],
                  "cross-check-meps": {
                    "cross-check-mep": [
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                "continuity-check-interval": {
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                "ais": {
                  "transmission": {
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                "service-properties": {
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          "domain-properties": {
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    "traceroute-cache": {
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}

a2_cfm_schema:

CFM global configuration

domains: object

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

nv-satellite-sla-processing-disable: null

Disable processing of Ethernet SLA packets on nV Satellite devices

traceroute-cache: object

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "domains": {
    "domain": [
      {
        "services": {
          "service": [
            {
              "mip-auto-creation": {
                "mip-policy": "string",
                "ccm-learning-enable": [ null ]
              },
              "tags": "integer",
              "log-efd": [ null ],
              "continuity-check-archive-hold-time": "integer",
              "efd2": {
                "enable": [ null ],
                "protection-switching-enable": [ null ]
              },
              "maximum-meps": "integer",
              "cross-check": {
                "auto": [ null ],
                "cross-check-meps": {
                  "cross-check-mep": [
                    {
                      "mep-id": "string",
                      "enable-mac-address": [ null ],
                      "mac-address": "string"
                    }
                  ]
                }
              },
              "continuity-check-interval": {
                "ccm-interval": "string",
                "loss-threshold": "integer"
              },
              "continuity-check-auto-traceroute": [ null ],
              "log-ais": [ null ],
              "service": "string",
              "ais": {
                "transmission": {
                  "cos": "string",
                  "ais-interval": "string"
                }
              },
              "service-properties": {
                "evi": "integer",
                "service-type": "string",
                "short-ma-name-string": "string",
                "short-ma-name-oui": "integer",
                "switching-name": "string",
                "remote-ce-id": "integer",
                "short-ma-name-umc": "string",
                "short-ma-name-format": "string",
                "group-name": "string",
                "short-ma-name-number": "integer",
                "ce-id": "integer",
                "short-ma-name-vpn-index": "integer",
                "short-ma-name-icc": "string"
              },
              "log-cross-check-errors": [ null ],
              "log-continuity-check-errors": [ null ],
              "log-continuity-check-state-changes": [ null ]
            }
          ]
        },
        "domain": "string",
        "domain-properties": {
          "mdid-string": "string",
          "mdid-format": "string",
          "mdid-mac-address": "string",
          "mdid-number": "integer",
          "level": "string"
        }
      }
    ]
  },
  "nv-satellite-sla-processing-disable": [ null ],
  "traceroute-cache": {
    "hold-time": "integer",
    "cache-size": "integer"
  }
}

a2_domains_schema:

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "domain": [
    {
      "services": {
        "service": [
          {
            "mip-auto-creation": {
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            "efd2": {
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            "cross-check": {
              "auto": [ null ],
              "cross-check-meps": {
                "cross-check-mep": [
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            "continuity-check-interval": {
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            "ais": {
              "transmission": {
                "cos": "string",
                "ais-interval": "string"
              }
            },
            "service-properties": {
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      "domain-properties": {
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}

a2_domain_schema:

services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "services": {
    "service": [
      {
        "mip-auto-creation": {
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        "efd2": {
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        "cross-check": {
          "auto": [ null ],
          "cross-check-meps": {
            "cross-check-mep": [
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        "continuity-check-interval": {
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        "ais": {
          "transmission": {
            "cos": "string",
            "ais-interval": "string"
          }
        },
        "service-properties": {
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  "domain-properties": {
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}

a2_mep_schema:

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "loss-measurement-counters": {
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  "sla-profile-target-mep-ids": {
    "sla-profile-target-mep-id": [
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    "sla-profile-target-mac-address": [
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  "mep-properties": {
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}

a2_sla-profile-target-mep-ids_schema:

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "sla-profile-target-mep-id": [
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  "sla-profile-target-mac-address": [
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}

a2_sla-profile-target-mep-id_schema:

profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

Example
{
  "profile": "string",
  "target-mep-id": "string"
}

a2_sla-profile-target-mac-address_schema:

profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "profile": "string",
  "target-mac-address": "string"
}

a2_mep-properties_schema:

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

Example
{
  "mep-id": "string",
  "service": "string"
}

a2_loss-measurement-counters_schema:

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}

a2_ais-up_schema:

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a2_transmission_schema:

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "cos": "string",
  "ais-interval": "string"
}

a2_carrier-delay_schema:

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}

a2_vlan-trunk-configuration_schema:

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

Example
{
  "native-vlan-identifier": {
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}

a2_native-vlan-identifier_schema:

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}

a2_egress-filtering_schema:

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

Example
{
  "egress-filtering-default-on": [ null ]
}

a2_traceroute-cache_schema:

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "hold-time": "integer",
  "cache-size": "integer"
}

a2_services_schema:

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "service": [
    {
      "mip-auto-creation": {
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      "efd2": {
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      "cross-check": {
        "auto": [ null ],
        "cross-check-meps": {
          "cross-check-mep": [
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      "continuity-check-interval": {
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      "ais": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      },
      "service-properties": {
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}

a2_service_schema:

mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "mip-auto-creation": {
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  "efd2": {
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  "cross-check": {
    "auto": [ null ],
    "cross-check-meps": {
      "cross-check-mep": [
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  "continuity-check-interval": {
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  "ais": {
    "transmission": {
      "cos": "string",
      "ais-interval": "string"
    }
  },
  "service-properties": {
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}

a2_efd2_schema:

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

Example
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}

a2_continuity-check-interval_schema:

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
Example
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}

a2_mip-auto-creation_schema:

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

Example
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}

a2_ais_schema:

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a2_cross-check_schema:

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "auto": [ null ],
  "cross-check-meps": {
    "cross-check-mep": [
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}

a2_cross-check-meps_schema:

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "cross-check-mep": [
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}

a2_cross-check-mep_schema:

mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}

a2_service-properties_schema:

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

Example
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}

a2_domain-properties_schema:

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}

a3_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces

Enable or disable link-status messages

Example
{
  "link-status": "string"
}

a3_interface-configurations_schema:

interface configurations

interface-configuration: object[]

The configuration for an interface

object
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-configuration": [
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      "mac-accounting": {
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      "ethernet-features": {
        "filtering": "string",
        "cfm": {
          "domains": {
            "domain": [
              {
                "domain": "string",
                "mep": {
                  "loss-measurement-counters": {
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  "sla-profile-target-mep-ids": {
                    "sla-profile-target-mep-id": [
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    "sla-profile-target-mac-address": [
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  "mep-properties": {
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          "ais-up": {
            "transmission": {
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      "vlan-trunk-configuration": {
        "native-vlan-identifier": {
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "bvi": {
        "host-routing": [ null ]
      },
      "carrier-delay": {
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      "vlan-sub-configuration": {
        "vlan-identifier": {
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      "l2-transport": {
        "propagate-remote-status": [ null ],
        "l2-protocols": {
          "l2-protocol": [
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        "l2-ethernet-features": {
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      "pseudowire-iw": {
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      "ethernet-service": {
        "local-traffic-default-encapsulation": {
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        "rewrite": {
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string",
          "outer-tag-type": "string"
        }
      }
    }
  ]
}

a3_interface-configuration_schema:

interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  "mac-accounting": {
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  "ethernet-features": {
    "filtering": "string",
    "cfm": {
      "domains": {
        "domain": [
          {
            "domain": "string",
            "mep": {
              "loss-measurement-counters": {
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              "sla-profile-target-mep-ids": {
                "sla-profile-target-mep-id": [
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                "sla-profile-target-mac-address": [
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              "mep-properties": {
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      "ais-up": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  "vlan-trunk-configuration": {
    "native-vlan-identifier": {
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "bvi": {
    "host-routing": [ null ]
  },
  "carrier-delay": {
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  "vlan-sub-configuration": {
    "vlan-identifier": {
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  "l2-transport": {
    "propagate-remote-status": [ null ],
    "l2-protocols": {
      "l2-protocol": [
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    "l2-ethernet-features": {
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  "pseudowire-iw": {
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  "ethernet-service": {
    "local-traffic-default-encapsulation": {
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    "rewrite": {
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    "encapsulation": {
      "ingress-destination-mac": "string"
    }
  }
}

a3_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a3_mtus_schema:

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a3_mtu_schema:

owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "owner": "string",
  "mtu": "integer"
}

a3_encapsulation_schema:

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a3_pseudowire-ether_schema:

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}

a3_pseudowire-iw_schema:

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}

a3_bvi_schema:

BVI attributes

host-routing: null

Enable host-routing on this BVI

Example
{
  "host-routing": [ null ]
}

a3_l2-transport_schema:

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "propagate-remote-status": [ null ],
  "l2-protocols": {
    "l2-protocol": [
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  "l2-ethernet-features": {
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}

a3_l2-protocols_schema:

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "l2-protocol": [
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}

a3_l2-protocol_schema:

mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}

a3_l2-ethernet-features_schema:

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}

a3_vlan-sub-configuration_schema:

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-identifier": {
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}

a3_vlan-identifier_schema:

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}

a3_ethernet-service_schema:

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "local-traffic-default-encapsulation": {
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  "rewrite": {
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  "encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a3_local-traffic-default-encapsulation_schema:

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}

a3_rewrite_schema:

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}

a3_ethernet-bng_schema:

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ambiguous-encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a3_ambiguous-encapsulation_schema:

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a3_mac-accounting_schema:

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

Example
{
  "ingress": [ null ],
  "egress": [ null ]
}

a3_ethernet-features_schema:

Ethernet Features Configuration

egress-filtering: object

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

cfm: object

CFM global configuration

domains: object

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

nv-satellite-sla-processing-disable: null

Disable processing of Ethernet SLA packets on nV Satellite devices

traceroute-cache: object

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "egress-filtering": {
    "egress-filtering-default-on": [ null ]
  },
  "cfm": {
    "domains": {
      "domain": [
        {
          "services": {
            "service": [
              {
                "mip-auto-creation": {
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                "efd2": {
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                "cross-check": {
                  "auto": [ null ],
                  "cross-check-meps": {
                    "cross-check-mep": [
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                "continuity-check-interval": {
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                "ais": {
                  "transmission": {
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                "service-properties": {
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          "domain-properties": {
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    "traceroute-cache": {
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}

a3_cfm_schema:

802.1ag Connectivity Fault Management MIB notification configuration

enable: null

Enable 802.1ag Connectivity Fault Management MIB notifications

Example
{
  "enable": [ null ]
}

a3_domains_schema:

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "domain": [
    {
      "services": {
        "service": [
          {
            "mip-auto-creation": {
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            "efd2": {
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            "cross-check": {
              "auto": [ null ],
              "cross-check-meps": {
                "cross-check-mep": [
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            "continuity-check-interval": {
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            "ais": {
              "transmission": {
                "cos": "string",
                "ais-interval": "string"
              }
            },
            "service-properties": {
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      "domain-properties": {
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}

a3_domain_schema:

services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "services": {
    "service": [
      {
        "mip-auto-creation": {
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        "efd2": {
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        "cross-check": {
          "auto": [ null ],
          "cross-check-meps": {
            "cross-check-mep": [
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        "continuity-check-interval": {
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        "ais": {
          "transmission": {
            "cos": "string",
            "ais-interval": "string"
          }
        },
        "service-properties": {
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  "domain-properties": {
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}

a3_mep_schema:

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "loss-measurement-counters": {
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  "sla-profile-target-mep-ids": {
    "sla-profile-target-mep-id": [
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    "sla-profile-target-mac-address": [
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  "mep-properties": {
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}

a3_sla-profile-target-mep-ids_schema:

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "sla-profile-target-mep-id": [
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  "sla-profile-target-mac-address": [
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}

a3_sla-profile-target-mep-id_schema:

profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

Example
{
  "profile": "string",
  "target-mep-id": "string"
}

a3_sla-profile-target-mac-address_schema:

profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "profile": "string",
  "target-mac-address": "string"
}

a3_mep-properties_schema:

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

Example
{
  "mep-id": "string",
  "service": "string"
}

a3_loss-measurement-counters_schema:

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}

a3_ais-up_schema:

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a3_transmission_schema:

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "cos": "string",
  "ais-interval": "string"
}

a3_carrier-delay_schema:

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}

a3_vlan-trunk-configuration_schema:

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

Example
{
  "native-vlan-identifier": {
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}

a3_native-vlan-identifier_schema:

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}

a3_egress-filtering_schema:

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

Example
{
  "egress-filtering-default-on": [ null ]
}

a3_traceroute-cache_schema:

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "hold-time": "integer",
  "cache-size": "integer"
}

a3_services_schema:

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "service": [
    {
      "mip-auto-creation": {
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      "efd2": {
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      "cross-check": {
        "auto": [ null ],
        "cross-check-meps": {
          "cross-check-mep": [
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      "continuity-check-interval": {
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      "ais": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      },
      "service-properties": {
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}

a3_service_schema:

mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "mip-auto-creation": {
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  "efd2": {
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  "cross-check": {
    "auto": [ null ],
    "cross-check-meps": {
      "cross-check-mep": [
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  "continuity-check-interval": {
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  "ais": {
    "transmission": {
      "cos": "string",
      "ais-interval": "string"
    }
  },
  "service-properties": {
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}

a3_efd2_schema:

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

Example
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}

a3_continuity-check-interval_schema:

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
Example
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}

a3_mip-auto-creation_schema:

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

Example
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}

a3_ais_schema:

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a3_cross-check_schema:

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "auto": [ null ],
  "cross-check-meps": {
    "cross-check-mep": [
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}

a3_cross-check-meps_schema:

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "cross-check-mep": [
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}

a3_cross-check-mep_schema:

mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}

a3_service-properties_schema:

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

Example
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}

a3_domain-properties_schema:

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}

TRAP-HOST-TABLE:

Common node of snmp, vrf

trap-hosts: object

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-hosts": {
    "trap-host": [
      {
        "encrypted-user-communities": {
          "encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-host": {
          "inform-encrypted-user-communities": {
            "inform-encrypted-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          },
          "inform-user-communities": {
            "inform-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          }
        },
        "ip-address": "string",
        "default-user-communities": {
          "default-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      }
    ]
  }
}

APPLIED-TO:

Common node of rule, rule-set

applied-to: object

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

CONTEXT-MAPPING-TABLE:

Common node of snmp, vrf

context-mappings: object

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

VAR-BIND-TABLE:

Common node of root-cause, non-root-cause

var-binds: object

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

CONTEXT-TABLE:

Common node of snmp, vrf

contexts: object

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "contexts": {
    "context": [
      {
        "context-name": "string"
      }
    ]
  }
}

a3_snmp_schema:

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a3_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]

Clear/encrypted SNMP community map

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a3_encrypted-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a3_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]

Name of the view

object
view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a3_view_schema:

view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a3_logging_schema:

SNMP logging

threshold: object

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

a3_threshold_schema:

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a3_administration_schema:

Container class for SNMP administration

default-communities: object

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

encrypted-communities: object

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a3_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a3_default-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a3_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a3_encrypted-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a3_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a3_engine-id_schema:

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a3_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a3_remote_schema:

remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a3_trap_schema:

Class to hold trap configurations

queue-length: integer

Message queue length for each TRAP host

range:"1..5000"
throttle-time: integer

Set throttle time for handling traps

range:"50..1000" units:"millisecond"
timeout: integer

Timeout for TRAP message retransmissions

range:"1..600000" units:"millisecond"
Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a3_drop-packet_schema:

SNMP packet drop config

unknown-user: null

Enable drop unknown user name

Example
{
  "unknown-user": [ null ]
}

a3_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a3_tos_schema:

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a3_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a3_system_schema:

container to hold system information

chassis-id: string

String to uniquely identify this chassis

contact: string

identification of the contact person for this managed node

location: string

The physical location of this node

Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a3_target_schema:

target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a3_targets_schema:

List of targets

target: object[]

Name of the target list

object
target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a3_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a3_vrf-name_schema:

name: string

VRF Name

Example
{
  "name": "string"
}

a3_target-addresses_schema:

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

Example
{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a3_target-address_schema:

ip-address: string

IPv4/Ipv6 address

Example
{
  "ip-address": "string"
}

a3_notification_schema:

Enable SNMP notifications

vpls: object

CISCO-IETF-VPLS-GENERIC-MIB notification configuration

status: null

Enable cvplsStatusChanged notification

full-raise: null

Enable cvplsFwdFullAlarmRaised notification

enable: null

Enable CISCO-IETF-VPLS-GENERIC-MIB notifications

full-clear: null

Enable cvplsFwdFullAlarmCleared notification

cfm: object

802.1ag Connectivity Fault Management MIB notification configuration

enable: null

Enable 802.1ag Connectivity Fault Management MIB notifications

snmp: object

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

l2vpn: object

CISCO-IETF-PW-MIB notification configuration

vc-up: null

Enable cpwVcUp notification

vc-down: null

Enable cpwVcDown notification

enable: null

Enable CISCO-IETF-PW-MIB notifications

cisco: null

Enable Cisco format including extra varbinds

Example
{
  "vpls": {
    "status": [ null ],
    "full-raise": [ null ],
    "enable": [ null ],
    "full-clear": [ null ]
  },
  "cfm": {
    "enable": [ null ]
  },
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  "l2vpn": {
    "vc-up": [ null ],
    "vc-down": [ null ],
    "enable": [ null ],
    "cisco": [ null ]
  }
}

a3_vpls_schema:

CISCO-IETF-VPLS-GENERIC-MIB notification configuration

status: null

Enable cvplsStatusChanged notification

full-raise: null

Enable cvplsFwdFullAlarmRaised notification

enable: null

Enable CISCO-IETF-VPLS-GENERIC-MIB notifications

full-clear: null

Enable cvplsFwdFullAlarmCleared notification

Example
{
  "status": [ null ],
  "full-raise": [ null ],
  "enable": [ null ],
  "full-clear": [ null ]
}

a3_l2vpn_schema:

CISCO-IETF-PW-MIB notification configuration

vc-up: null

Enable cpwVcUp notification

vc-down: null

Enable cpwVcDown notification

enable: null

Enable CISCO-IETF-PW-MIB notifications

cisco: null

Enable Cisco format including extra varbinds

Example
{
  "vc-up": [ null ],
  "vc-down": [ null ],
  "enable": [ null ],
  "cisco": [ null ]
}

a3_correlator_schema:

Configure properties of the trap correlator

rules: object

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

rule-sets: object

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

buffer-size: integer

Configure size of the correlator buffer

range:"1024..2147483647" units:"byte"
Example
{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a3_rules_schema:

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a3_rule_schema:

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a3_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a3_root-cause_schema:

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a3_var-binds_schema:

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a3_var-bind_schema:

oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a3_match_schema:

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "index": "string",
  "value": "string"
}

a3_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a3_non-root-cause_schema:

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a3_applied-to_schema:

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a3_hosts_schema:

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a3_host_schema:

port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "port": "string",
  "ip-address": "string"
}

a3_rule-sets_schema:

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a3_rule-set_schema:

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a3_rulenames_schema:

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a3_rulename_schema:

rulename: string

Rule name

Example
{
  "rulename": "string"
}

a3_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer

per process memory limit in kilo bytes

range:"100..200000" units:"kilobyte"
transfers: object

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

objects: object

Configure an Object List

object: object[]

Name of the object List

object
object-list-name: string

Name of the object List

objects: object

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

type: null

Configure object list name

schemas: object

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a3_schemas_schema:

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a3_schema_schema:

schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a3_instance_schema:

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a3_objects_schema:

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

Example
{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a3_object_schema:

oid: string

Object name or OID

Example
{
  "oid": "string"
}

a3_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a3_transfer_schema:

retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a3_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

Example
{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a3_transfer-schema_schema:

schema-name: string

Schema that contains objects to be collected

Example
{
  "schema-name": "string"
}

a3_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]

Unencrpted SNMP community map name

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a3_default-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a3_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer

Drop time in seconds for incoming queue (default 1 sec)

range:"0..300" units:"second"
throttle-rate: integer

Throttle time in milliseconds for incoming queue (default 500 msec)

range:"0..1000" units:"millisecond"
Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a3_timeouts_schema:

SNMP timeouts

duplicates: integer

Duplicate request feature timeout

range:"0..20" units:"second" default:"1"
pdu-stats: integer

SNMP pdu statistics timeout

range:"1..10" units:"second" default:"2"
in-qdrop: integer

incoming queue drop feature timeout

range:"0..20" units:"second" default:"10"
subagent: integer

Sub-Agent Request timeout

range:"1..20" units:"second" default:"10"
Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a3_users_schema:

Define a user who can access the SNMP engine

user: object[]

Name of the user

object
v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a3_user_schema:

v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a3_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]

VRF name

name: string

VRF name

Example
{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a3_vrf_schema:

name: string

VRF name

Example
{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a3_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a3_trap-host_schema:

encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a3_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a3_encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a3_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a3_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a3_inform-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a3_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a3_inform-encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a3_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a3_default-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a3_contexts_schema:

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a3_context_schema:

context-name: string

Context Name

Example
{
  "context-name": "string"
}

a3_context-mappings_schema:

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a3_context-mapping_schema:

context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a3_groups_schema:

Define a User Security Model group

group: object[]

Name of the group

object
name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a3_group_schema:

name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a3_mib_schema:

mib

Example

a4_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces

Enable or disable link-status messages

Example
{
  "link-status": "string"
}

a4_interface-configurations_schema:

interface configurations

interface-configuration: object[]

The configuration for an interface

object
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-configuration": [
    {
      "interface-mode-non-physical": "string",
      "description": "string",
      "interface-virtual": [ null ],
      "mac-accounting": {
        "ingress": [ null ],
        "egress": [ null ]
      },
      "bandwidth": "integer",
      "ethernet-features": {
        "filtering": "string",
        "cfm": {
          "domains": {
            "domain": [
              {
                "domain": "string",
                "mep": {
                  "loss-measurement-counters": {
                    "cfg-type": "string",
                    "cos7": "string",
                    "cos6": "string",
                    "cos5": "string",
                    "cos4": "string",
                    "cos3": "string",
                    "cos2": "string",
                    "cos1": "string",
                    "cos0": "string"
                  },
                  "sla-profile-target-mep-ids": {
                    "sla-profile-target-mep-id": [
                      {
                        "profile": "string",
                        "target-mep-id": "string"
                      }
                    ],
                    "sla-profile-target-mac-address": [
                      {
                        "profile": "string",
                        "target-mac-address": "string"
                      }
                    ]
                  },
                  "mep-properties": {
                    "mep-id": "string",
                    "service": "string"
                  },
                  "cos": "string"
                }
              }
            ]
          },
          "ais-up": {
            "transmission": {
              "cos": "string",
              "ais-interval": "string"
            }
          }
        }
      },
      "shutdown": [ null ],
      "vlan-trunk-configuration": {
        "native-vlan-identifier": {
          "vlan-type": "string",
          "vlan-identifier": "string"
        },
        "tunneling-ethertype": "string"
      },
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "bvi": {
        "host-routing": [ null ]
      },
      "carrier-delay": {
        "carrier-delay-up": "integer",
        "carrier-delay-down": "integer"
      },
      "vlan-sub-configuration": {
        "vlan-identifier": {
          "vlan-type": "string",
          "first-tag": "string",
          "second-tag": "string"
        }
      },
      "l2-transport": {
        "propagate-remote-status": [ null ],
        "l2-protocols": {
          "l2-protocol": [
            {
              "mpls-exp-bits-value": "string",
              "l2-protocol-name": "string",
              "mode": "string"
            }
          ]
        },
        "enabled": [ null ],
        "l2-ethernet-features": {
          "egress-filtering": "string",
          "source-bypass-egress-filtering": [ null ]
        }
      },
      "pseudowire-iw": {
        "generic-interface-list": "string",
        "l2-overhead": "integer"
      },
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "interface-name": "string",
      "secondary-admin-state": "string",
      "ethernet-service": {
        "local-traffic-default-encapsulation": {
          "outer-tag-type": "string",
          "outer-vlan-id": "string",
          "inner-vlan-id": "string"
        },
        "rewrite": {
          "inner-tag-value": "string",
          "rewrite-type": "string",
          "outer-tag-value": "string",
          "inner-tag-type": "string",
          "outer-tag-type": "string"
        }
      }
    }
  ]
}

a4_interface-configuration_schema:

interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport

The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.

description: string

The description of this interface

interface-virtual: null

The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.

mac-accounting: object

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

bandwidth: integer

The bandwidth of the interface in kbps

range:"0..4294967295" units:"kbit/s"
ethernet-features: object

Ethernet Features Configuration

filtering: string

Ingress Ethernet frame filtering

cfm: object

CFM interface configuration

domains: object

Domain-specific interface configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
domain: string

Maintenance Domain

mep: object

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

ais-up: object

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

shutdown: null

The existence of this configuration indicates the interface is shut down

vlan-trunk-configuration: object

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

active: string

Whether the interface is active or preconfigured

encapsulation: object

The encapsulation on the interface

encapsulation: string

The encapsulation - e.g. hdlc, ppp

capsulation-options: integer

The options for this capsulation, usually '0'

bvi: object

BVI attributes

host-routing: null

Enable host-routing on this BVI

carrier-delay: object

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

vlan-sub-configuration: object

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

l2-transport: object

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

pseudowire-iw: object

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

dampening: object

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
interface-name: string

The name of the interface

secondary-admin-state: string normal, maintenance

The secondary admin state of the interface

ethernet-service: object

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

pseudowire-ether: object

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

link-status: null

Enable interface and line-protocol state change alarms

mtus: object

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

range:"64..65535"
object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
ethernet-bng: object

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "interface-mode-non-physical": "string",
  "description": "string",
  "interface-virtual": [ null ],
  "mac-accounting": {
    "ingress": [ null ],
    "egress": [ null ]
  },
  "bandwidth": "integer",
  "ethernet-features": {
    "filtering": "string",
    "cfm": {
      "domains": {
        "domain": [
          {
            "domain": "string",
            "mep": {
              "loss-measurement-counters": {
                "cfg-type": "string",
                "cos7": "string",
                "cos6": "string",
                "cos5": "string",
                "cos4": "string",
                "cos3": "string",
                "cos2": "string",
                "cos1": "string",
                "cos0": "string"
              },
              "sla-profile-target-mep-ids": {
                "sla-profile-target-mep-id": [
                  {
                    "profile": "string",
                    "target-mep-id": "string"
                  }
                ],
                "sla-profile-target-mac-address": [
                  {
                    "profile": "string",
                    "target-mac-address": "string"
                  }
                ]
              },
              "mep-properties": {
                "mep-id": "string",
                "service": "string"
              },
              "cos": "string"
            }
          }
        ]
      },
      "ais-up": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      }
    }
  },
  "shutdown": [ null ],
  "vlan-trunk-configuration": {
    "native-vlan-identifier": {
      "vlan-type": "string",
      "vlan-identifier": "string"
    },
    "tunneling-ethertype": "string"
  },
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "bvi": {
    "host-routing": [ null ]
  },
  "carrier-delay": {
    "carrier-delay-up": "integer",
    "carrier-delay-down": "integer"
  },
  "vlan-sub-configuration": {
    "vlan-identifier": {
      "vlan-type": "string",
      "first-tag": "string",
      "second-tag": "string"
    }
  },
  "l2-transport": {
    "propagate-remote-status": [ null ],
    "l2-protocols": {
      "l2-protocol": [
        {
          "mpls-exp-bits-value": "string",
          "l2-protocol-name": "string",
          "mode": "string"
        }
      ]
    },
    "enabled": [ null ],
    "l2-ethernet-features": {
      "egress-filtering": "string",
      "source-bypass-egress-filtering": [ null ]
    }
  },
  "pseudowire-iw": {
    "generic-interface-list": "string",
    "l2-overhead": "integer"
  },
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "interface-name": "string",
  "secondary-admin-state": "string",
  "ethernet-service": {
    "local-traffic-default-encapsulation": {
      "outer-tag-type": "string",
      "outer-vlan-id": "string",
      "inner-vlan-id": "string"
    },
    "rewrite": {
      "inner-tag-value": "string",
      "rewrite-type": "string",
      "outer-tag-value": "string",
      "inner-tag-type": "string",
      "outer-tag-type": "string"
    },
    "encapsulation": {
      "ingress-destination-mac": "string"
    }
  }
}

a4_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp

Dampening Arguments

suppress-threshold: integer

Suppress threshold

range:"1..20000"
half-life: integer

Decay half life (in minutes)

range:"1..45" units:"minute"
suppress-time: integer

Max suppress time (in minutes)

range:"1..255" units:"minute"
reuse-threshold: integer

Reuse threshold

range:"1..20000"
restart-penalty: integer

Restart penalty

range:"0..20000"
Example
{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a4_mtus_schema:

The MTU configuration for the interface

mtu: object[]

The MTU for the interface

object
owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a4_mtu_schema:

owner: string

The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'

mtu: integer

The MTU value

range:"64..65535"
Example
{
  "owner": "string",
  "mtu": "integer"
}

a4_encapsulation_schema:

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a4_pseudowire-ether_schema:

PW-Ether attributes

l2-overhead: integer

PW Ether L2 overhead requirement

generic-interface-list: string

Name of the interface list

Example
{
  "l2-overhead": "integer",
  "generic-interface-list": "string"
}

a4_pseudowire-iw_schema:

PW-IW attributes

generic-interface-list: string

Name of the interface list

l2-overhead: integer

L2 overhead size in bytes

Example
{
  "generic-interface-list": "string",
  "l2-overhead": "integer"
}

a4_bvi_schema:

BVI attributes

host-routing: null

Enable host-routing on this BVI

Example
{
  "host-routing": [ null ]
}

a4_l2-transport_schema:

Interface Layer 2 Transport service configuration data

propagate-remote-status: null

Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state

l2-protocols: object

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

enabled: null

This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.

l2-ethernet-features: object

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "propagate-remote-status": [ null ],
  "l2-protocols": {
    "l2-protocol": [
      {
        "mpls-exp-bits-value": "string",
        "l2-protocol-name": "string",
        "mode": "string"
      }
    ]
  },
  "enabled": [ null ],
  "l2-ethernet-features": {
    "egress-filtering": "string",
    "source-bypass-egress-filtering": [ null ]
  }
}

a4_l2-protocols_schema:

Interface specific Layer 2 protocol handling

l2-protocol: object[]

Handling of a specific Layer 2 protocol

object
mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "l2-protocol": [
    {
      "mpls-exp-bits-value": "string",
      "l2-protocol-name": "string",
      "mode": "string"
    }
  ]
}

a4_l2-protocol_schema:

mpls-exp-bits-value: string

The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop

l2-protocol-name: string

Protocol name

mode: string

How to handle the protocol's packets

Example
{
  "mpls-exp-bits-value": "string",
  "l2-protocol-name": "string",
  "mode": "string"
}

a4_l2-ethernet-features_schema:

L2 Ethernet Features Configuration

egress-filtering: string

Egress Ethernet filtering

source-bypass-egress-filtering: null

Mark all ingress packets to bypass any egress VLAN filter

Example
{
  "egress-filtering": "string",
  "source-bypass-egress-filtering": [ null ]
}

a4_vlan-sub-configuration_schema:

IEEE 802.1Q VLAN subinterface configuration

vlan-identifier: object

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-identifier": {
    "vlan-type": "string",
    "first-tag": "string",
    "second-tag": "string"
  }
}

a4_vlan-identifier_schema:

The VLAN tag stack associated with this sub-interface.

vlan-type: string

Whether this sub-interface is dot1ad or dot1Q

first-tag: string

First (outermost) VLAN tag value

second-tag: string

Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces

Example
{
  "vlan-type": "string",
  "first-tag": "string",
  "second-tag": "string"
}

a4_ethernet-service_schema:

Ethernet service configuration

local-traffic-default-encapsulation: object

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

rewrite: object

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

encapsulation: object

The encapsulation of this Ethernet service

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "local-traffic-default-encapsulation": {
    "outer-tag-type": "string",
    "outer-vlan-id": "string",
    "inner-vlan-id": "string"
  },
  "rewrite": {
    "inner-tag-value": "string",
    "rewrite-type": "string",
    "outer-tag-value": "string",
    "inner-tag-type": "string",
    "outer-tag-type": "string"
  },
  "encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a4_local-traffic-default-encapsulation_schema:

The default encapsulation to be used for locally-sourced packets

outer-tag-type: string

Type of outer tag

outer-vlan-id: string

VLAN id for outer tag

inner-vlan-id: string

Optional VLAN Id for inner Dot1Q tag

Example
{
  "outer-tag-type": "string",
  "outer-vlan-id": "string",
  "inner-vlan-id": "string"
}

a4_rewrite_schema:

The rewrite operation for the Ethernet service

inner-tag-value: string

VLAN Id of innermost tag to be pushed

rewrite-type: string

The type of rewrite to perform

outer-tag-value: string

VLAN Id of outermost tag to be pushed

inner-tag-type: string

Type of innermost tag to be pushed

outer-tag-type: string

Type of outermost tag to be pushed

Example
{
  "inner-tag-value": "string",
  "rewrite-type": "string",
  "outer-tag-value": "string",
  "inner-tag-type": "string",
  "outer-tag-type": "string"
}

a4_ethernet-bng_schema:

Ethernet Infra BNG specific configuration

ambiguous-encapsulation: object

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ambiguous-encapsulation": {
    "ingress-destination-mac": "string",
    "additional-range4-high": "string",
    "additional-range1-low": "string",
    "inner-range1-high": "string",
    "additional-range8-high": "string",
    "additional-range6-low": "string",
    "outer-range1-low": "string",
    "inner-tag-type": "string",
    "additional-range3-low": "string",
    "inner-class-of-service": "string",
    "additional-range8-low": "string",
    "payload-ethertype-match": "string",
    "additional-range2-low": "string",
    "inner-range1-low": "string",
    "additional-range7-high": "string",
    "outer-class-of-service": "string",
    "additional-range3-high": "string",
    "ingress-source-mac": "string",
    "outer-range1-high": "string",
    "additional-range7-low": "string",
    "additional-range5-high": "string",
    "additional-range6-high": "string",
    "outer-tag-type": "string",
    "additional-range5-low": "string",
    "additional-range2-high": "string",
    "exact": [ null ],
    "additional-range4-low": "string",
    "additional-range1-high": "string"
  }
}

a4_ambiguous-encapsulation_schema:

L3 Ambiguous encapsulation

ingress-destination-mac: string

Destination MAC address to match on egress

additional-range4-high: string

High value of forth additional range for tag match

additional-range1-low: string

Low value of first additional range for tag match

inner-range1-high: string

High value of first range for inner tag match

additional-range8-high: string

High value of eighth additional range for tag match

additional-range6-low: string

Low value of sixth additional range for tag match

outer-range1-low: string

Low value of first range for outer tag match

inner-tag-type: string

Type of tag for inner match (if present)

additional-range3-low: string

Low value of third additional range for tag match

inner-class-of-service: string

Value to match against Class Of Service bits for inner tag

additional-range8-low: string

Low value of eighth additional range for tag match

payload-ethertype-match: string

Which payload ethertype values to match

additional-range2-low: string

Low value of second additional range for tag match

inner-range1-low: string

Low value of first range for inner tag match

additional-range7-high: string

High value of seventh additional range for tag match

outer-class-of-service: string

Value to match against Class Of Service bits for outer tag

additional-range3-high: string

High value of third additional range for tag match

ingress-source-mac: string

Source MAC address to match on ingress

outer-range1-high: string

High value of first range for outer tag match

additional-range7-low: string

Low value of seventh additional range for tag match

additional-range5-high: string

High value of fifth additional range for tag match

additional-range6-high: string

High value of sixth additional range for tag match

outer-tag-type: string

Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match

additional-range5-low: string

Low value of fifth additional range for tag match

additional-range2-high: string

High value of second additional range for tag match

exact: null

Only match packets with no more tags than explicitly matched

additional-range4-low: string

Low value of forth additional range for tag match

additional-range1-high: string

High value of first additional range for tag match

Example
{
  "ingress-destination-mac": "string",
  "additional-range4-high": "string",
  "additional-range1-low": "string",
  "inner-range1-high": "string",
  "additional-range8-high": "string",
  "additional-range6-low": "string",
  "outer-range1-low": "string",
  "inner-tag-type": "string",
  "additional-range3-low": "string",
  "inner-class-of-service": "string",
  "additional-range8-low": "string",
  "payload-ethertype-match": "string",
  "additional-range2-low": "string",
  "inner-range1-low": "string",
  "additional-range7-high": "string",
  "outer-class-of-service": "string",
  "additional-range3-high": "string",
  "ingress-source-mac": "string",
  "outer-range1-high": "string",
  "additional-range7-low": "string",
  "additional-range5-high": "string",
  "additional-range6-high": "string",
  "outer-tag-type": "string",
  "additional-range5-low": "string",
  "additional-range2-high": "string",
  "exact": [ null ],
  "additional-range4-low": "string",
  "additional-range1-high": "string"
}

a4_mac-accounting_schema:

MAC Accounting Configuration

ingress: null

Per MAC address accounting statistics

egress: null

Per MAC address accounting statistics

Example
{
  "ingress": [ null ],
  "egress": [ null ]
}

a4_ethernet-features_schema:

Ethernet Features Configuration

egress-filtering: object

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

cfm: object

CFM global configuration

domains: object

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

nv-satellite-sla-processing-disable: null

Disable processing of Ethernet SLA packets on nV Satellite devices

traceroute-cache: object

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "egress-filtering": {
    "egress-filtering-default-on": [ null ]
  },
  "cfm": {
    "domains": {
      "domain": [
        {
          "services": {
            "service": [
              {
                "mip-auto-creation": {
                  "mip-policy": "string",
                  "ccm-learning-enable": [ null ]
                },
                "tags": "integer",
                "log-efd": [ null ],
                "continuity-check-archive-hold-time": "integer",
                "efd2": {
                  "enable": [ null ],
                  "protection-switching-enable": [ null ]
                },
                "maximum-meps": "integer",
                "cross-check": {
                  "auto": [ null ],
                  "cross-check-meps": {
                    "cross-check-mep": [
                      {
                        "mep-id": "string",
                        "enable-mac-address": [ null ],
                        "mac-address": "string"
                      }
                    ]
                  }
                },
                "continuity-check-interval": {
                  "ccm-interval": "string",
                  "loss-threshold": "integer"
                },
                "continuity-check-auto-traceroute": [ null ],
                "log-ais": [ null ],
                "service": "string",
                "ais": {
                  "transmission": {
                    "cos": "string",
                    "ais-interval": "string"
                  }
                },
                "service-properties": {
                  "evi": "integer",
                  "service-type": "string",
                  "short-ma-name-string": "string",
                  "short-ma-name-oui": "integer",
                  "switching-name": "string",
                  "remote-ce-id": "integer",
                  "short-ma-name-umc": "string",
                  "short-ma-name-format": "string",
                  "group-name": "string",
                  "short-ma-name-number": "integer",
                  "ce-id": "integer",
                  "short-ma-name-vpn-index": "integer",
                  "short-ma-name-icc": "string"
                },
                "log-cross-check-errors": [ null ],
                "log-continuity-check-errors": [ null ],
                "log-continuity-check-state-changes": [ null ]
              }
            ]
          },
          "domain": "string",
          "domain-properties": {
            "mdid-string": "string",
            "mdid-format": "string",
            "mdid-mac-address": "string",
            "mdid-number": "integer",
            "level": "string"
          }
        }
      ]
    },
    "nv-satellite-sla-processing-disable": [ null ],
    "traceroute-cache": {
      "hold-time": "integer",
      "cache-size": "integer"
    }
  }
}

a4_cfm_schema:

802.1ag Connectivity Fault Management MIB notification configuration

enable: null

Enable 802.1ag Connectivity Fault Management MIB notifications

Example
{
  "enable": [ null ]
}

a4_domains_schema:

Domain-specific global configuration

domain: object[]

Configuration for a particular Maintenance Domain

object
services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "domain": [
    {
      "services": {
        "service": [
          {
            "mip-auto-creation": {
              "mip-policy": "string",
              "ccm-learning-enable": [ null ]
            },
            "tags": "integer",
            "log-efd": [ null ],
            "continuity-check-archive-hold-time": "integer",
            "efd2": {
              "enable": [ null ],
              "protection-switching-enable": [ null ]
            },
            "maximum-meps": "integer",
            "cross-check": {
              "auto": [ null ],
              "cross-check-meps": {
                "cross-check-mep": [
                  {
                    "mep-id": "string",
                    "enable-mac-address": [ null ],
                    "mac-address": "string"
                  }
                ]
              }
            },
            "continuity-check-interval": {
              "ccm-interval": "string",
              "loss-threshold": "integer"
            },
            "continuity-check-auto-traceroute": [ null ],
            "log-ais": [ null ],
            "service": "string",
            "ais": {
              "transmission": {
                "cos": "string",
                "ais-interval": "string"
              }
            },
            "service-properties": {
              "evi": "integer",
              "service-type": "string",
              "short-ma-name-string": "string",
              "short-ma-name-oui": "integer",
              "switching-name": "string",
              "remote-ce-id": "integer",
              "short-ma-name-umc": "string",
              "short-ma-name-format": "string",
              "group-name": "string",
              "short-ma-name-number": "integer",
              "ce-id": "integer",
              "short-ma-name-vpn-index": "integer",
              "short-ma-name-icc": "string"
            },
            "log-cross-check-errors": [ null ],
            "log-continuity-check-errors": [ null ],
            "log-continuity-check-state-changes": [ null ]
          }
        ]
      },
      "domain": "string",
      "domain-properties": {
        "mdid-string": "string",
        "mdid-format": "string",
        "mdid-mac-address": "string",
        "mdid-number": "integer",
        "level": "string"
      }
    }
  ]
}

a4_domain_schema:

services: object

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

domain: string

Maintenance Domain

domain-properties: object

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "services": {
    "service": [
      {
        "mip-auto-creation": {
          "mip-policy": "string",
          "ccm-learning-enable": [ null ]
        },
        "tags": "integer",
        "log-efd": [ null ],
        "continuity-check-archive-hold-time": "integer",
        "efd2": {
          "enable": [ null ],
          "protection-switching-enable": [ null ]
        },
        "maximum-meps": "integer",
        "cross-check": {
          "auto": [ null ],
          "cross-check-meps": {
            "cross-check-mep": [
              {
                "mep-id": "string",
                "enable-mac-address": [ null ],
                "mac-address": "string"
              }
            ]
          }
        },
        "continuity-check-interval": {
          "ccm-interval": "string",
          "loss-threshold": "integer"
        },
        "continuity-check-auto-traceroute": [ null ],
        "log-ais": [ null ],
        "service": "string",
        "ais": {
          "transmission": {
            "cos": "string",
            "ais-interval": "string"
          }
        },
        "service-properties": {
          "evi": "integer",
          "service-type": "string",
          "short-ma-name-string": "string",
          "short-ma-name-oui": "integer",
          "switching-name": "string",
          "remote-ce-id": "integer",
          "short-ma-name-umc": "string",
          "short-ma-name-format": "string",
          "group-name": "string",
          "short-ma-name-number": "integer",
          "ce-id": "integer",
          "short-ma-name-vpn-index": "integer",
          "short-ma-name-icc": "string"
        },
        "log-cross-check-errors": [ null ],
        "log-continuity-check-errors": [ null ],
        "log-continuity-check-state-changes": [ null ]
      }
    ]
  },
  "domain": "string",
  "domain-properties": {
    "mdid-string": "string",
    "mdid-format": "string",
    "mdid-mac-address": "string",
    "mdid-number": "integer",
    "level": "string"
  }
}

a4_mep_schema:

MEP Configuration

loss-measurement-counters: object

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

sla-profile-target-mep-ids: object

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

mep-properties: object

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

cos: string

The Class of Service bits for this MEP

Example
{
  "loss-measurement-counters": {
    "cfg-type": "string",
    "cos7": "string",
    "cos6": "string",
    "cos5": "string",
    "cos4": "string",
    "cos3": "string",
    "cos2": "string",
    "cos1": "string",
    "cos0": "string"
  },
  "sla-profile-target-mep-ids": {
    "sla-profile-target-mep-id": [
      {
        "profile": "string",
        "target-mep-id": "string"
      }
    ],
    "sla-profile-target-mac-address": [
      {
        "profile": "string",
        "target-mac-address": "string"
      }
    ]
  },
  "mep-properties": {
    "mep-id": "string",
    "service": "string"
  },
  "cos": "string"
}

a4_sla-profile-target-mep-ids_schema:

SLA specific configuration

sla-profile-target-mep-id: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

sla-profile-target-mac-address: object[]

Configuration for a particular SLA operation

object
profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "sla-profile-target-mep-id": [
    {
      "profile": "string",
      "target-mep-id": "string"
    }
  ],
  "sla-profile-target-mac-address": [
    {
      "profile": "string",
      "target-mac-address": "string"
    }
  ]
}

a4_sla-profile-target-mep-id_schema:

profile: string

SLA profile name

target-mep-id: string

Target MEP-ID

Example
{
  "profile": "string",
  "target-mep-id": "string"
}

a4_sla-profile-target-mac-address_schema:

profile: string

SLA profile name

target-mac-address: string

Target MAC address

Example
{
  "profile": "string",
  "target-mac-address": "string"
}

a4_mep-properties_schema:

Properties for this MEP

mep-id: string

MEP ID

service: string

Service (Maintenance Association)

Example
{
  "mep-id": "string",
  "service": "string"
}

a4_loss-measurement-counters_schema:

Loss-measurement specific configuration

cfg-type: string aggregate, list, range

Aggregate, List, or Range

cos7: string

CoS bits for per-CoS counters - list item

cos6: string

CoS bits for per-CoS counters - list item

cos5: string

CoS bits for per-CoS counters - list item

cos4: string

CoS bits for per-CoS counters - list item

cos3: string

CoS bits for per-CoS counters - list item

cos2: string

CoS bits for per-CoS counters - list item

cos1: string

CoS bits for per-CoS counters - end of range or list item

cos0: string

CoS bits for per-CoS counters - start of range or list item

Example
{
  "cfg-type": "string",
  "cos7": "string",
  "cos6": "string",
  "cos5": "string",
  "cos4": "string",
  "cos3": "string",
  "cos2": "string",
  "cos1": "string",
  "cos0": "string"
}

a4_ais-up_schema:

Interface specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a4_transmission_schema:

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "cos": "string",
  "ais-interval": "string"
}

a4_carrier-delay_schema:

Set the carrier transition delay on an interface in msecs

carrier-delay-up: integer

Carrier Delay (up) in msecs

range:"1..65535"
carrier-delay-down: integer

Carrier Delay down in msecs, must be set to 0

Example
{
  "carrier-delay-up": "integer",
  "carrier-delay-down": "integer"
}

a4_vlan-trunk-configuration_schema:

IEEE 802.1Q VLAN trunk interface configuration

native-vlan-identifier: object

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

tunneling-ethertype: string 0x9100, 0x9200

The outer ethertype used in Q-in-Q frames. The default value is 0x8100

Example
{
  "native-vlan-identifier": {
    "vlan-type": "string",
    "vlan-identifier": "string"
  },
  "tunneling-ethertype": "string"
}

a4_native-vlan-identifier_schema:

The Native VLAN identifier associated with this trunk interface

vlan-type: string

Whether this interface is dot1ad or dot1Q

vlan-identifier: string

VLAN identifier

Example
{
  "vlan-type": "string",
  "vlan-identifier": "string"
}

a4_egress-filtering_schema:

Egress Filtering Configuration

egress-filtering-default-on: null

Whether Egress Filtering is on by default

Example
{
  "egress-filtering-default-on": [ null ]
}

a4_traceroute-cache_schema:

Traceroute Cache Configuration

hold-time: integer

Hold Time in minutes

range:"1..525600" default:"100"
cache-size: integer

Cache Size limit (number of replies)

range:"1..4294967295" default:"100"
Example
{
  "hold-time": "integer",
  "cache-size": "integer"
}

a4_services_schema:

Service-specific global configuration

service: object[]

Configuration for a particular Service (Maintenance Association)

object
mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "service": [
    {
      "mip-auto-creation": {
        "mip-policy": "string",
        "ccm-learning-enable": [ null ]
      },
      "tags": "integer",
      "log-efd": [ null ],
      "continuity-check-archive-hold-time": "integer",
      "efd2": {
        "enable": [ null ],
        "protection-switching-enable": [ null ]
      },
      "maximum-meps": "integer",
      "cross-check": {
        "auto": [ null ],
        "cross-check-meps": {
          "cross-check-mep": [
            {
              "mep-id": "string",
              "enable-mac-address": [ null ],
              "mac-address": "string"
            }
          ]
        }
      },
      "continuity-check-interval": {
        "ccm-interval": "string",
        "loss-threshold": "integer"
      },
      "continuity-check-auto-traceroute": [ null ],
      "log-ais": [ null ],
      "service": "string",
      "ais": {
        "transmission": {
          "cos": "string",
          "ais-interval": "string"
        }
      },
      "service-properties": {
        "evi": "integer",
        "service-type": "string",
        "short-ma-name-string": "string",
        "short-ma-name-oui": "integer",
        "switching-name": "string",
        "remote-ce-id": "integer",
        "short-ma-name-umc": "string",
        "short-ma-name-format": "string",
        "group-name": "string",
        "short-ma-name-number": "integer",
        "ce-id": "integer",
        "short-ma-name-vpn-index": "integer",
        "short-ma-name-icc": "string"
      },
      "log-cross-check-errors": [ null ],
      "log-continuity-check-errors": [ null ],
      "log-continuity-check-state-changes": [ null ]
    }
  ]
}

a4_service_schema:

mip-auto-creation: object

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

tags: integer

The number of tags to use when sending CFM packets from up MEPs in this Service

log-efd: null

Enable logging

continuity-check-archive-hold-time: integer

How long to store information for peer MEPs that have timed out

range:"1..65535" default:"100"
efd2: object

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

maximum-meps: integer

Limit on the number of MEPs in the service

range:"2..8190" default:"100"
cross-check: object

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

continuity-check-interval: object

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
continuity-check-auto-traceroute: null

Automatically trigger a traceroute when a peer MEP times out

log-ais: null

Log receipt of AIS and LCK messages

service: string

Service (Maintenance Association)

ais: object

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

service-properties: object

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

log-cross-check-errors: null

Log Cross-check Errors detected for peer MEPs

log-continuity-check-errors: null

Log CCM Errors detected for peer MEPs

log-continuity-check-state-changes: null

Log peer MEPs state changes

Example
{
  "mip-auto-creation": {
    "mip-policy": "string",
    "ccm-learning-enable": [ null ]
  },
  "tags": "integer",
  "log-efd": [ null ],
  "continuity-check-archive-hold-time": "integer",
  "efd2": {
    "enable": [ null ],
    "protection-switching-enable": [ null ]
  },
  "maximum-meps": "integer",
  "cross-check": {
    "auto": [ null ],
    "cross-check-meps": {
      "cross-check-mep": [
        {
          "mep-id": "string",
          "enable-mac-address": [ null ],
          "mac-address": "string"
        }
      ]
    }
  },
  "continuity-check-interval": {
    "ccm-interval": "string",
    "loss-threshold": "integer"
  },
  "continuity-check-auto-traceroute": [ null ],
  "log-ais": [ null ],
  "service": "string",
  "ais": {
    "transmission": {
      "cos": "string",
      "ais-interval": "string"
    }
  },
  "service-properties": {
    "evi": "integer",
    "service-type": "string",
    "short-ma-name-string": "string",
    "short-ma-name-oui": "integer",
    "switching-name": "string",
    "remote-ce-id": "integer",
    "short-ma-name-umc": "string",
    "short-ma-name-format": "string",
    "group-name": "string",
    "short-ma-name-number": "integer",
    "ce-id": "integer",
    "short-ma-name-vpn-index": "integer",
    "short-ma-name-icc": "string"
  },
  "log-cross-check-errors": [ null ],
  "log-continuity-check-errors": [ null ],
  "log-continuity-check-state-changes": [ null ]
}

a4_efd2_schema:

Enable EFD to bring down ports when MEPs detect errors

enable: null

Enable EFD

protection-switching-enable: null

Enable protection switching notifications

Example
{
  "enable": [ null ],
  "protection-switching-enable": [ null ]
}

a4_continuity-check-interval_schema:

Continuity Check Interval and Loss Threshold. Configuring the interval enables Continuity Check.

ccm-interval: string

CCM Interval

loss-threshold: integer

Loss Threshold (default 3)

range:"2..255" default:3)"
Example
{
  "ccm-interval": "string",
  "loss-threshold": "integer"
}

a4_mip-auto-creation_schema:

MIP Auto-creation Policy

mip-policy: string all, lower-mep-only

MIP Auto-creation Policy

ccm-learning-enable: null

Enable CCM Learning at MIPs in this service

Example
{
  "mip-policy": "string",
  "ccm-learning-enable": [ null ]
}

a4_ais_schema:

Service specific AIS configuration

transmission: object

AIS transmission configuration

cos: string

Class of Service bits

ais-interval: string

AIS Interval

Example
{
  "transmission": {
    "cos": "string",
    "ais-interval": "string"
  }
}

a4_cross-check_schema:

Cross-check configuration

auto: null

Enable automatic MEP cross-check

cross-check-meps: object

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "auto": [ null ],
  "cross-check-meps": {
    "cross-check-mep": [
      {
        "mep-id": "string",
        "enable-mac-address": [ null ],
        "mac-address": "string"
      }
    ]
  }
}

a4_cross-check-meps_schema:

Cross-check MEPs

cross-check-mep: object[]

MEP ID and optional MAC Address for Cross-check

object
mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "cross-check-mep": [
    {
      "mep-id": "string",
      "enable-mac-address": [ null ],
      "mac-address": "string"
    }
  ]
}

a4_cross-check-mep_schema:

mep-id: string

MEP ID

enable-mac-address: null

MAC Address is specified

mac-address: string

MAC Address

Example
{
  "mep-id": "string",
  "enable-mac-address": [ null ],
  "mac-address": "string"
}

a4_service-properties_schema:

Fundamental properties of the service (maintenance association)

evi: integer

EVPN ID

range:"1..65534"
service-type: string bridge-domain, p2p-cross-connect, mp2mp-cross-connect, vlan-aware-flexible-cross-connect, vlan-unaware-flexible-cross-connect, down-meps

Type of Service

short-ma-name-string: string

String Short MA Name, if format is String

short-ma-name-oui: integer

VPN OUI, if Short MA Name format is VPN_ID

range:"0..16777215"
switching-name: string

Bridge Domain or Cross-connect name, if Service Type is BridgeDomain or CrossConnect

remote-ce-id: integer

Remote Customer Edge Identifier

range:"1..16384"
short-ma-name-umc: string

Unique MEG ID Code (UMC), if format is ICCBased

short-ma-name-format: string vlan-id, string, number, vpn-id, icc-based

Short MA Name Format

group-name: string

Bridge Group or Cross-connect Group, if Service Type is BridgeDomain or CrossConnect

short-ma-name-number: integer

Numeric Short MA Name, if format is VlanID or Number

range:"0..65535"
ce-id: integer

Local Customer Edge Identifier

range:"1..16384"
short-ma-name-vpn-index: integer

VPN Index, if Short MA Name format is VPN_ID

short-ma-name-icc: string

ITU Carrier Code (ICC), if format is ICCBased

Example
{
  "evi": "integer",
  "service-type": "string",
  "short-ma-name-string": "string",
  "short-ma-name-oui": "integer",
  "switching-name": "string",
  "remote-ce-id": "integer",
  "short-ma-name-umc": "string",
  "short-ma-name-format": "string",
  "group-name": "string",
  "short-ma-name-number": "integer",
  "ce-id": "integer",
  "short-ma-name-vpn-index": "integer",
  "short-ma-name-icc": "string"
}

a4_domain-properties_schema:

Fundamental properties of the domain

mdid-string: string

String MDID, if MDID format is String or DNSLike

mdid-format: string null, dns-like, mac-address, string

Maintenance Domain ID Format

mdid-mac-address: string

MAC Address, if MDID Format is MACAddress

mdid-number: integer

Unsigned 16-bit Interger, if MDID Format is MACAddress

range:"0..65535"
level: string

Maintenance Domain Level

Example
{
  "mdid-string": "string",
  "mdid-format": "string",
  "mdid-mac-address": "string",
  "mdid-number": "integer",
  "level": "string"
}

a4_snmp_schema:

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a4_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]

Clear/encrypted SNMP community map

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a4_encrypted-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a4_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]

Name of the view

object
view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a4_view_schema:

view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a4_logging_schema:

SNMP logging

threshold: object

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

a4_threshold_schema:

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a4_administration_schema:

Container class for SNMP administration

default-communities: object

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

encrypted-communities: object

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a4_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a4_default-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a4_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a4_encrypted-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a4_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a4_engine-id_schema:

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a4_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a4_remote_schema:

remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a4_trap_schema:

Class to hold trap configurations

queue-length: integer

Message queue length for each TRAP host

range:"1..5000"
throttle-time: integer

Set throttle time for handling traps

range:"50..1000" units:"millisecond"
timeout: integer

Timeout for TRAP message retransmissions

range:"1..600000" units:"millisecond"
Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a4_drop-packet_schema:

SNMP packet drop config

unknown-user: null

Enable drop unknown user name

Example
{
  "unknown-user": [ null ]
}

a4_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a4_tos_schema:

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a4_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a4_system_schema:

container to hold system information

chassis-id: string

String to uniquely identify this chassis

contact: string

identification of the contact person for this managed node

location: string

The physical location of this node

Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a4_target_schema:

target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a4_targets_schema:

List of targets

target: object[]

Name of the target list

object
target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a4_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a4_vrf-name_schema:

name: string

VRF Name

Example
{
  "name": "string"
}

a4_target-addresses_schema:

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

Example
{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a4_target-address_schema:

ip-address: string

IPv4/Ipv6 address

Example
{
  "ip-address": "string"
}

a4_notification_schema:

Enable SNMP notifications

vpls: object

CISCO-IETF-VPLS-GENERIC-MIB notification configuration

status: null

Enable cvplsStatusChanged notification

full-raise: null

Enable cvplsFwdFullAlarmRaised notification

enable: null

Enable CISCO-IETF-VPLS-GENERIC-MIB notifications

full-clear: null

Enable cvplsFwdFullAlarmCleared notification

cfm: object

802.1ag Connectivity Fault Management MIB notification configuration

enable: null

Enable 802.1ag Connectivity Fault Management MIB notifications

snmp: object

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

l2vpn: object

CISCO-IETF-PW-MIB notification configuration

vc-up: null

Enable cpwVcUp notification

vc-down: null

Enable cpwVcDown notification

enable: null

Enable CISCO-IETF-PW-MIB notifications

cisco: null

Enable Cisco format including extra varbinds

Example
{
  "vpls": {
    "status": [ null ],
    "full-raise": [ null ],
    "enable": [ null ],
    "full-clear": [ null ]
  },
  "cfm": {
    "enable": [ null ]
  },
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  "l2vpn": {
    "vc-up": [ null ],
    "vc-down": [ null ],
    "enable": [ null ],
    "cisco": [ null ]
  }
}

a4_vpls_schema:

CISCO-IETF-VPLS-GENERIC-MIB notification configuration

status: null

Enable cvplsStatusChanged notification

full-raise: null

Enable cvplsFwdFullAlarmRaised notification

enable: null

Enable CISCO-IETF-VPLS-GENERIC-MIB notifications

full-clear: null

Enable cvplsFwdFullAlarmCleared notification

Example
{
  "status": [ null ],
  "full-raise": [ null ],
  "enable": [ null ],
  "full-clear": [ null ]
}

a4_l2vpn_schema:

CISCO-IETF-PW-MIB notification configuration

vc-up: null

Enable cpwVcUp notification

vc-down: null

Enable cpwVcDown notification

enable: null

Enable CISCO-IETF-PW-MIB notifications

cisco: null

Enable Cisco format including extra varbinds

Example
{
  "vc-up": [ null ],
  "vc-down": [ null ],
  "enable": [ null ],
  "cisco": [ null ]
}

a4_correlator_schema:

Configure properties of the trap correlator

rules: object

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

rule-sets: object

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

buffer-size: integer

Configure size of the correlator buffer

range:"1024..2147483647" units:"byte"
Example
{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a4_rules_schema:

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a4_rule_schema:

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a4_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a4_root-cause_schema:

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a4_var-binds_schema:

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a4_var-bind_schema:

oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a4_match_schema:

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "index": "string",
  "value": "string"
}

a4_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a4_non-root-cause_schema:

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a4_applied-to_schema:

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a4_hosts_schema:

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a4_host_schema:

port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "port": "string",
  "ip-address": "string"
}

a4_rule-sets_schema:

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a4_rule-set_schema:

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a4_rulenames_schema:

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a4_rulename_schema:

rulename: string

Rule name

Example
{
  "rulename": "string"
}

a4_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer

per process memory limit in kilo bytes

range:"100..200000" units:"kilobyte"
transfers: object

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

objects: object

Configure an Object List

object: object[]

Name of the object List

object
object-list-name: string

Name of the object List

objects: object

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

type: null

Configure object list name

schemas: object

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a4_schemas_schema:

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a4_schema_schema:

schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a4_instance_schema:

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a4_objects_schema:

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

Example
{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a4_object_schema:

oid: string

Object name or OID

Example
{
  "oid": "string"
}

a4_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a4_transfer_schema:

retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a4_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

Example
{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a4_transfer-schema_schema:

schema-name: string

Schema that contains objects to be collected

Example
{
  "schema-name": "string"
}

a4_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]

Unencrpted SNMP community map name

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a4_default-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a4_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer

Drop time in seconds for incoming queue (default 1 sec)

range:"0..300" units:"second"
throttle-rate: integer

Throttle time in milliseconds for incoming queue (default 500 msec)

range:"0..1000" units:"millisecond"
Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a4_timeouts_schema:

SNMP timeouts

duplicates: integer

Duplicate request feature timeout

range:"0..20" units:"second" default:"1"
pdu-stats: integer

SNMP pdu statistics timeout

range:"1..10" units:"second" default:"2"
in-qdrop: integer

incoming queue drop feature timeout

range:"0..20" units:"second" default:"10"
subagent: integer

Sub-Agent Request timeout

range:"1..20" units:"second" default:"10"
Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a4_users_schema:

Define a user who can access the SNMP engine

user: object[]

Name of the user

object
v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a4_user_schema:

v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a4_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]

VRF name

name: string

VRF name

Example
{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a4_vrf_schema:

name: string

VRF name

Example
{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a4_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a4_trap-host_schema:

encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a4_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a4_encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a4_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a4_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a4_inform-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a4_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a4_inform-encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a4_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a4_default-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a4_contexts_schema:

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a4_context_schema:

context-name: string

Context Name

Example
{
  "context-name": "string"
}

a4_context-mappings_schema:

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a4_context-mapping_schema:

context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a4_groups_schema:

Define a User Security Model group

group: object[]

Name of the group

object
name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a4_group_schema:

name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a4_mib_schema:

mib

Example

a4_sla_schema:

SLA prtocol and profile Configuration

protocols: object

Table of all SLA protocols

ethernet: object

The Ethernet SLA protocol

profiles: object

Table of SLA profiles on the protocol

profile: object[]

Name of the profile

object
statistics: object

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
probe: object

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
profile-name: string

Profile name

packet-type: string

The possible packet types are cfm-loopback, cfm-delay-measurement, cfm-delay-measurement-version-0, cfm-loss-measurement and cfm-synthetic-loss-measurement

schedule: object

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "protocols": {
    "ethernet": {
      "profiles": {
        "profile": [
          {
            "statistics": {
              "statistic": [
                {
                  "buckets-size": {
                    "buckets-size": "integer",
                    "buckets-size-unit": "string"
                  },
                  "enable": [ null ],
                  "buckets-archive": "integer",
                  "statistic-name": "string",
                  "aggregation": {
                    "bins-count": "integer",
                    "bins-width": "integer",
                    "bins-width-tenths": "integer"
                  }
                }
              ]
            },
            "probe": {
              "priority": "integer",
              "packet-size-and-padding": {
                "padding-type": "string",
                "padding-value": "string",
                "size": "integer"
              },
              "send": {
                "burst-interval-unit": "string",
                "send-type": "string",
                "packet-interval": "integer",
                "burst-interval": "integer",
                "packet-count": "integer",
                "packet-interval-unit": "string"
              },
              "synthetic-loss-calculation-packets": "integer"
            },
            "profile-name": "string",
            "packet-type": "string",
            "schedule": {
              "probe-duration": "integer",
              "probe-interval": "integer",
              "probe-duration-unit": "string",
              "start-time-hour": "integer",
              "probe-interval-unit": "string",
              "start-time-minute": "integer",
              "probe-interval-day": "string",
              "start-time-second": "integer"
            }
          }
        ]
      }
    }
  }
}

a4_protocols_schema:

Table of all SLA protocols

ethernet: object

The Ethernet SLA protocol

profiles: object

Table of SLA profiles on the protocol

profile: object[]

Name of the profile

object
statistics: object

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
probe: object

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
profile-name: string

Profile name

packet-type: string

The possible packet types are cfm-loopback, cfm-delay-measurement, cfm-delay-measurement-version-0, cfm-loss-measurement and cfm-synthetic-loss-measurement

schedule: object

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "ethernet": {
    "profiles": {
      "profile": [
        {
          "statistics": {
            "statistic": [
              {
                "buckets-size": {
                  "buckets-size": "integer",
                  "buckets-size-unit": "string"
                },
                "enable": [ null ],
                "buckets-archive": "integer",
                "statistic-name": "string",
                "aggregation": {
                  "bins-count": "integer",
                  "bins-width": "integer",
                  "bins-width-tenths": "integer"
                }
              }
            ]
          },
          "probe": {
            "priority": "integer",
            "packet-size-and-padding": {
              "padding-type": "string",
              "padding-value": "string",
              "size": "integer"
            },
            "send": {
              "burst-interval-unit": "string",
              "send-type": "string",
              "packet-interval": "integer",
              "burst-interval": "integer",
              "packet-count": "integer",
              "packet-interval-unit": "string"
            },
            "synthetic-loss-calculation-packets": "integer"
          },
          "profile-name": "string",
          "packet-type": "string",
          "schedule": {
            "probe-duration": "integer",
            "probe-interval": "integer",
            "probe-duration-unit": "string",
            "start-time-hour": "integer",
            "probe-interval-unit": "string",
            "start-time-minute": "integer",
            "probe-interval-day": "string",
            "start-time-second": "integer"
          }
        }
      ]
    }
  }
}

a4_ethernet_schema:

The Ethernet SLA protocol

profiles: object

Table of SLA profiles on the protocol

profile: object[]

Name of the profile

object
statistics: object

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
probe: object

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
profile-name: string

Profile name

packet-type: string

The possible packet types are cfm-loopback, cfm-delay-measurement, cfm-delay-measurement-version-0, cfm-loss-measurement and cfm-synthetic-loss-measurement

schedule: object

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "profiles": {
    "profile": [
      {
        "statistics": {
          "statistic": [
            {
              "buckets-size": {
                "buckets-size": "integer",
                "buckets-size-unit": "string"
              },
              "enable": [ null ],
              "buckets-archive": "integer",
              "statistic-name": "string",
              "aggregation": {
                "bins-count": "integer",
                "bins-width": "integer",
                "bins-width-tenths": "integer"
              }
            }
          ]
        },
        "probe": {
          "priority": "integer",
          "packet-size-and-padding": {
            "padding-type": "string",
            "padding-value": "string",
            "size": "integer"
          },
          "send": {
            "burst-interval-unit": "string",
            "send-type": "string",
            "packet-interval": "integer",
            "burst-interval": "integer",
            "packet-count": "integer",
            "packet-interval-unit": "string"
          },
          "synthetic-loss-calculation-packets": "integer"
        },
        "profile-name": "string",
        "packet-type": "string",
        "schedule": {
          "probe-duration": "integer",
          "probe-interval": "integer",
          "probe-duration-unit": "string",
          "start-time-hour": "integer",
          "probe-interval-unit": "string",
          "start-time-minute": "integer",
          "probe-interval-day": "string",
          "start-time-second": "integer"
        }
      }
    ]
  }
}

a4_profiles_schema:

Table of SLA profiles on the protocol

profile: object[]

Name of the profile

object
statistics: object

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
probe: object

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
profile-name: string

Profile name

packet-type: string

The possible packet types are cfm-loopback, cfm-delay-measurement, cfm-delay-measurement-version-0, cfm-loss-measurement and cfm-synthetic-loss-measurement

schedule: object

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "profile": [
    {
      "statistics": {
        "statistic": [
          {
            "buckets-size": {
              "buckets-size": "integer",
              "buckets-size-unit": "string"
            },
            "enable": [ null ],
            "buckets-archive": "integer",
            "statistic-name": "string",
            "aggregation": {
              "bins-count": "integer",
              "bins-width": "integer",
              "bins-width-tenths": "integer"
            }
          }
        ]
      },
      "probe": {
        "priority": "integer",
        "packet-size-and-padding": {
          "padding-type": "string",
          "padding-value": "string",
          "size": "integer"
        },
        "send": {
          "burst-interval-unit": "string",
          "send-type": "string",
          "packet-interval": "integer",
          "burst-interval": "integer",
          "packet-count": "integer",
          "packet-interval-unit": "string"
        },
        "synthetic-loss-calculation-packets": "integer"
      },
      "profile-name": "string",
      "packet-type": "string",
      "schedule": {
        "probe-duration": "integer",
        "probe-interval": "integer",
        "probe-duration-unit": "string",
        "start-time-hour": "integer",
        "probe-interval-unit": "string",
        "start-time-minute": "integer",
        "probe-interval-day": "string",
        "start-time-second": "integer"
      }
    }
  ]
}

a4_profile_schema:

statistics: object

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
probe: object

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
profile-name: string

Profile name

packet-type: string

The possible packet types are cfm-loopback, cfm-delay-measurement, cfm-delay-measurement-version-0, cfm-loss-measurement and cfm-synthetic-loss-measurement

schedule: object

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "statistics": {
    "statistic": [
      {
        "buckets-size": {
          "buckets-size": "integer",
          "buckets-size-unit": "string"
        },
        "enable": [ null ],
        "buckets-archive": "integer",
        "statistic-name": "string",
        "aggregation": {
          "bins-count": "integer",
          "bins-width": "integer",
          "bins-width-tenths": "integer"
        }
      }
    ]
  },
  "probe": {
    "priority": "integer",
    "packet-size-and-padding": {
      "padding-type": "string",
      "padding-value": "string",
      "size": "integer"
    },
    "send": {
      "burst-interval-unit": "string",
      "send-type": "string",
      "packet-interval": "integer",
      "burst-interval": "integer",
      "packet-count": "integer",
      "packet-interval-unit": "string"
    },
    "synthetic-loss-calculation-packets": "integer"
  },
  "profile-name": "string",
  "packet-type": "string",
  "schedule": {
    "probe-duration": "integer",
    "probe-interval": "integer",
    "probe-duration-unit": "string",
    "start-time-hour": "integer",
    "probe-interval-unit": "string",
    "start-time-minute": "integer",
    "probe-interval-day": "string",
    "start-time-second": "integer"
  }
}

a4_statistics_schema:

Statistics configuration for the SLA profile

statistic: object[]

Type of statistic

object
buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
Example
{
  "statistic": [
    {
      "buckets-size": {
        "buckets-size": "integer",
        "buckets-size-unit": "string"
      },
      "enable": [ null ],
      "buckets-archive": "integer",
      "statistic-name": "string",
      "aggregation": {
        "bins-count": "integer",
        "bins-width": "integer",
        "bins-width-tenths": "integer"
      }
    }
  ]
}

a4_statistic_schema:

buckets-size: object

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

enable: null

Enable statistic gathering of the metric

buckets-archive: integer

Number of buckets to archive in memory

range:"1..100"
statistic-name: string

The type of statistic to measure

aggregation: object

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
Example
{
  "buckets-size": {
    "buckets-size": "integer",
    "buckets-size-unit": "string"
  },
  "enable": [ null ],
  "buckets-archive": "integer",
  "statistic-name": "string",
  "aggregation": {
    "bins-count": "integer",
    "bins-width": "integer",
    "bins-width-tenths": "integer"
  }
}

a4_buckets-size_schema:

Size of the buckets into which statistics are collected

buckets-size: integer

Size of each bucket

range:"1..100"
buckets-size-unit: string

Unit associated with the BucketsSize

Example
{
  "buckets-size": "integer",
  "buckets-size-unit": "string"
}

a4_aggregation_schema:

Aggregation to apply to results for the statistic

bins-count: integer

Number of bins to aggregate results into (0 for no aggregation)

range:"0..100"
bins-width: integer

Width of each bin

range:"1..10000"
bins-width-tenths: integer

Tenths portion of the bin width

range:"0..9"
Example
{
  "bins-count": "integer",
  "bins-width": "integer",
  "bins-width-tenths": "integer"
}

a4_schedule_schema:

Schedule to use for probes within an operation

probe-duration: integer

Duration of each probe. This must be specified if, and only if, ProbeDurationUnit is specified.

range:"1..3600"
probe-interval: integer

Interval between probes. This must be specified if, and only if, ProbeIntervalUnit is not 'Week' or 'Day'.

range:"1..90"
probe-duration-unit: string

Time unit associated with the ProbeDuration. The value must not be 'Once'.

start-time-hour: integer

Time after midnight (in UTC) to send the first packet each day.

range:"0..23"
probe-interval-unit: string

Time unit associated with the ProbeInterval. The value must not be 'Once'. If 'Week' or 'Day' is specified, probes are scheduled weekly or daily respectively.

start-time-minute: integer

Time after midnight (in UTC) to send the first packet each day. This must be specified if, and only if, StartTimeHour is specified.

range:"0..59"
probe-interval-day: string

Day of week on which to schedule probes. This must be specified if, and only if, ProbeIntervalUnit is 'Week'.

start-time-second: integer

Time after midnight (in UTC) to send the first packet each day. This must only be specified if StartTimeHour is specified, and must not be specified if ProbeIntervalUnit is 'Week' or 'Day'.

range:"0..59"
Example
{
  "probe-duration": "integer",
  "probe-interval": "integer",
  "probe-duration-unit": "string",
  "start-time-hour": "integer",
  "probe-interval-unit": "string",
  "start-time-minute": "integer",
  "probe-interval-day": "string",
  "start-time-second": "integer"
}

a4_probe_schema:

Probe configuration for the SLA profile

priority: integer

Priority class to assign to outgoing SLA packets

range:"0..7"
packet-size-and-padding: object

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
send: object

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

synthetic-loss-calculation-packets: integer

Number of packets to use in each FLR calculation

range:"10..12096000"
Example
{
  "priority": "integer",
  "packet-size-and-padding": {
    "padding-type": "string",
    "padding-value": "string",
    "size": "integer"
  },
  "send": {
    "burst-interval-unit": "string",
    "send-type": "string",
    "packet-interval": "integer",
    "burst-interval": "integer",
    "packet-count": "integer",
    "packet-interval-unit": "string"
  },
  "synthetic-loss-calculation-packets": "integer"
}

a4_send_schema:

Schedule to use for packets within a burst. The default value is to send a single packet once.

burst-interval-unit: string

Time unit associated with the BurstInterval . This must be specified if, and only if, SendType is 'Burst'.

send-type: string

The packet distribution: single packets or bursts of packets. If 'Burst' is specified , PacketCount and BurstInterval must be specified.

packet-interval: integer

Interval between packets. This must be specified if, and only if, PacketIntervalUnit is not 'Once'.

range:"1..30000"
burst-interval: integer

Interval between bursts. This must be specified if, and only if, the SendType is 'Burst' and the 'BurstIntervalUnit' is not 'Once'.

range:"1..3600"
packet-count: integer

The number of packets in each burst. This must be specified if, and only if, the SendType is 'Burst'.

range:"2..1200"
packet-interval-unit: string

Time unit associated with the PacketInterval

Example
{
  "burst-interval-unit": "string",
  "send-type": "string",
  "packet-interval": "integer",
  "burst-interval": "integer",
  "packet-count": "integer",
  "packet-interval-unit": "string"
}

a4_packet-size-and-padding_schema:

Minimum size to pad outgoing packet to

padding-type: string

Type of padding to be used for the packet

padding-value: string

Pattern to be used for hex padding. This can be specified if, and only if, the PaddingType is 'Hex'.

size: integer

Minimum size to pad outgoing packet to

range:"1..9000"
Example
{
  "padding-type": "string",
  "padding-value": "string",
  "size": "integer"
}